new HueRotation()
HueRotation filter class
- Source:
- See:
-
- fabric.Image.filters.HueRotation#initialize for constructor definition
- ImageFilters demo
Example
var filter = new fabric.Image.filters.HueRotation({
rotation: -0.5
});
object.filters.push(filter);
object.applyFilters();
Extends
Members
mainParameter
Describe the property that is the filter parameter
- Default Value:
- rotation
- Source:
rotation
HueRotation value, from -1 to 1.
the unit is radians
- Source:
type
Filter type
- Overrides:
- Default Value:
- HueRotation
- Source:
Methods
applyTo(options)
Apply this filter to the input image data provided.
Determines whether to use WebGL or Canvas2D based on the options.webgl flag.
Parameters:
Name | Type | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
- Overrides:
- Source:
applyToWebGL(options)
Apply this filter using webgl.
Parameters:
Name | Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
- Inherited From:
- Source:
createHelpLayer()
If needed by a 2d filter, this functions can create an helper canvas to be used
remember that options.targetCanvas is available for use till end of chain.
- Inherited From:
- Source:
createProgram(gl, fragmentSource, vertexSource)
Compile this filter's shader program.
Parameters:
Name | Type | Description |
---|---|---|
gl |
WebGLRenderingContext | The GL canvas context to use for shader compilation. |
fragmentSource |
String | fragmentShader source for compilation |
vertexSource |
String | vertexShader source for compilation |
- Inherited From:
- Source:
getAttributeLocations(gl, program) → {Object}
Return a map of attribute names to WebGLAttributeLocation objects.
Parameters:
Name | Type | Description |
---|---|---|
gl |
WebGLRenderingContext | The canvas context used to compile the shader program. |
program |
WebGLShaderProgram | The shader program from which to take attribute locations. |
- Inherited From:
- Source:
Returns:
A map of attribute names to attribute locations.
- Type
- Object
getUniformLocations(gl, program) → {Object}
Return a map of uniform names to WebGLUniformLocation objects.
Intended to be overridden by subclasses.
Parameters:
Name | Type | Description |
---|---|---|
gl |
WebGLRenderingContext | The canvas context used to compile the shader program. |
program |
WebGLShaderProgram | The shader program from which to take uniform locations. |
- Inherited From:
- Source:
Returns:
A map of uniform names to uniform locations.
- Type
- Object
initialize(optionsopt)
Constructor
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
Options object |
- Inherited From:
- Source:
isNeutralState(options)
HueRotation isNeutralState implementation
Used only in image applyFilters to discard filters that will not have an effect
on the image
Parameters:
Name | Type | Description |
---|---|---|
options |
Object |
- Overrides:
- Source:
retrieveShader(options)
Retrieves the cached shader.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
- Inherited From:
- Source:
sendAttributeData(gl, attributeLocations)
Send attribute data from this filter to its shader program on the GPU.
Parameters:
Name | Type | Description |
---|---|---|
gl |
WebGLRenderingContext | The canvas context used to compile the shader program. |
attributeLocations |
Object | A map of shader attribute names to their locations. |
- Inherited From:
- Source:
sendUniformData(gl, uniformLocations)
Send uniform data from this filter to its shader program on the GPU.
Intended to be overridden by subclasses.
Parameters:
Name | Type | Description |
---|---|---|
gl |
WebGLRenderingContext | The canvas context used to compile the shader program. |
uniformLocations |
Object | A map of shader uniform names to their locations. |
- Inherited From:
- Source:
setOptions(optionsopt)
Sets filter's properties from options
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
Options object |
- Inherited From:
- Source:
toJSON() → {Object}
Returns a JSON representation of an instance
- Inherited From:
- Source:
Returns:
JSON
- Type
- Object
toObject() → {Object}
Returns object representation of an instance
- Inherited From:
- Source:
Returns:
Object representation of an instance
- Type
- Object