Parasol Framework Manual

Provides pixel remapping; equivalent to feComponentTransfer in SVG.

The RemapFX class provides an implementation of the feComponentTransfer functionality in SVG.

Internally the pixel rendering process is implemented using pixel lookup tables. As such this particular effect carries minimal overhead compared to most other effect classes.

Structure

The RemapFX class consists of the following fields:

Access	Name	Type	Comment
	XMLDef	STRING	Returns an SVG compliant XML string that describes the filter.

Actions

The following actions are currently supported:

Name

Comment

Draw

Render the effect to the target bitmap.

ERR acDraw(*Object, DOUBLE X, DOUBLE Y, DOUBLE Width, DOUBLE Height)

Input	Description
X	The X position of the region to be drawn.
Y	The Y position of the region to be drawn.
Width	The width of the region to be drawn.
Height	The height of the region to be drawn.

Methods

The following methods are currently supported:

Name Comment

SelectDiscrete Apply the discrete function to a pixel component.

ERR rf::SelectDiscrete(OBJECTPTR Object, CMP Component, DOUBLE * Values, LONG Size)

Input	Description
Component	The pixel component to which the discrete function must be applied.
Values	A list of values for the discrete function.
Size	Total number of elements in the `Values` list.

This method will apply the table function to a selected RGBA pixel component. A list of values is required with a minimum size of 1.

SelectGamma Apply the gamma function to a pixel component.

ERR rf::SelectGamma(OBJECTPTR Object, CMP Component, DOUBLE Amplitude, DOUBLE Offset, DOUBLE Exponent)

Input	Description
Component	The pixel component to which the gamma function must be applied.
Amplitude	The amplitude of the gamma function.
Offset	The offset of the gamma function.
Exponent	The exponent of the gamma function.

This method will apply the gamma function to a selected RGBA pixel component. The gamma function is written as C' = Amplitude * pow(C, Exponent) + Offset.

SelectIdentity Apply the identity function to a pixel component.

ERR rf::SelectIdentity(OBJECTPTR Object, CMP Component)

Input	Description
Component	The pixel component to which the identity function must be applied.

Selecting the identity function for a pixel component will render it as its original value. By default, all pixels will use this function if no other option is chosen.

SelectInvert Apply the invert function to a pixel component.

ERR rf::SelectInvert(OBJECTPTR Object, CMP Component)

Input	Description
Component	The pixel component to which the function must be applied.

This method will apply the invert function to a selected RGBA pixel component. The function is written as C' = 1.0 - C.

This feature is not compatible with SVG.

SelectLinear Apply the linear function to a pixel component.

ERR rf::SelectLinear(OBJECTPTR Object, CMP Component, DOUBLE Slope, DOUBLE Intercept)

Input	Description
Component	The pixel component to which the function must be applied.
Slope	The slope of the linear function.
Intercept	The intercept of the linear function.

This method will apply the linear function to a selected RGBA pixel component. The function is written as C' = (Slope * C) + Intercept.

SelectMask Apply the mask function to a pixel component.

ERR rf::SelectMask(OBJECTPTR Object, CMP Component, LONG Mask)

Input	Description
Component	The pixel component to which the function must be applied.
Mask	The bit mask to be AND'd with each value.

This method will apply the mask function to a selected RGBA pixel component. The function is written as C' = C & Mask. This algorithm is particularly useful for lowering the bit depth of colours, e.g. a value of 0xf0 will reduce 8 bit colours to 4 bit.

This feature is not compatible with SVG.

SelectTable Apply the table function to a pixel component.

ERR rf::SelectTable(OBJECTPTR Object, CMP Component, DOUBLE * Values, LONG Size)

Input	Description
Component	The pixel component to which the table function must be applied.
Values	A list of values for the table function.
Size	Total number of elements in the value list.

This method will apply the table function to a selected RGBA pixel component. A list of values is required with a minimum size of 1.

If a single table value is supplied then the component will be output as a constant with no interpolation applied.

Name	Description
CMP::ALL	All colour channels.
CMP::ALPHA	The alpha channel.
CMP::BLUE	The blue colour channel.
CMP::GREEN	The green colour channel.
CMP::RED	The red colour channel.

Class Info
ID	ID_REMAPFX
Category	Graphics
Include	modules/remapfx.h
Version	1

RemapFX Class

Structure

Actions

Methods

CMP Type

Class Info

Class List