src/colour-ramp.h File Reference

Code for managing colour ramps. More...

#include "sphore.h"

Go to the source code of this file.

Typedefs
typedef struct _colour_ramp	colour_ramp_t
	Public handel to colour ramp objects.
Functions
colour_ramp_t *	colour_ramp_create ()
	Creates a new colour ramp.
void	colour_ramp_destroy (colour_ramp_t *cr)
	Frees the memory accosiated with a given colour ramp.
SREbool	colour_ramp_set (colour_ramp_t *cr, int n, float *controlPoints, float *red, float *green, float *blue)
	Sets the colour ramp to the one given.
void	colour_ramp_get_rgb (colour_ramp_t *cr, float pos, float *red, float *green, float *blue)
	Gets the red, green and blue values from the given colour ramp at the given position.
void	colour_ramp_onto_device (colour_ramp_t *cr)

---

Detailed Description

Code for managing colour ramps.

---

Typedef Documentation

typedef struct _colour_ramp colour_ramp_t

Public handel to colour ramp objects.

Memory managment with colour_ramp_create and colour_ramp_destroy

---

Function Documentation

colour_ramp_t* colour_ramp_create

(

)

Creates a new colour ramp.

The ramp will be initialised to a monochrome ramp.

Returns:

A pointer to the new colour ramp, or NULL if something failed.

void colour_ramp_destroy

(

colour_ramp_t *

cr

)

Frees the memory accosiated with a given colour ramp.

Parameters:

[in]

cr

The colour ramp to destroy.

void colour_ramp_get_rgb	(	colour_ramp_t *	cr,
		float	pos,
		float *	red,
		float *	green,
		float *	blue
	)

Gets the red, green and blue values from the given colour ramp at the given position.

Parameters:

[in]	cr	The ramp to query.
[in]	pos	The position on the ramp in normalised units.
[out]	red	Gets set to the red component at pos.
[out]	green	Gets set to the green component at pos.
[out]	blue	Gets set to the blue component at pos.

void colour_ramp_onto_device

(

colour_ramp_t *

cr

)

SREbool colour_ramp_set	(	colour_ramp_t *	cr,
		int	n,
		float *	controlPoints,
		float *	red,
		float *	green,
		float *	blue
	)

Sets the colour ramp to the one given.

Parameters:

[in]	cr	The colour ramp object to set
[in]	n	The number of control points to be used
[in]	controlPoints	The position of the control points on the ramp. in normalised units i.e. 0 at the begining, 1 at the end.
[in]	red	The value of the red component of the colour at each control point.
[in]	green	The value of the green component of the colour at each control point.
[in]	blue	The value of the blue component of the colour at each control point.

Returns:

The success of setting the colour ramp.