CC3GLSLUniform Class Reference
| Inherits from | CC3GLSLVariable : NSObject |
| Declared in | CC3GLSLVariable.h |
Overview
Represents a uniform variable used in a GLSL shader program.
The value of the uniform in the GL engine is tracked and is only set within the GL engine if the value has changed from its current value.
Tasks
-
typeproperty -
– setFloat: -
– setFloat:at: -
– setPoint: -
– setPoint:at: -
– setVector: -
– setVector:at: -
– setVector4: -
– setVector4:at: -
– setQuaternion: -
– setQuaternion:at: -
– setMatrix3x3: -
– setMatrix3x3:at: -
– setMatrix4x3: -
– setMatrix4x3:at: -
– setMatrix4x4: -
– setMatrix4x4:at: -
– setInteger: -
– setInteger:at: -
– setIntPoint: -
– setIntPoint:at: -
– setIntVector: -
– setIntVector:at: -
– setIntVector4: -
– setIntVector4:at: -
– setBoolean: -
– setBooleanVectorX:andY: -
– setBooleanVectorX:andY:andZ: -
– setBooleanVectorX:andY:andZ:andW: -
– setBoolean:at: -
– setBooleanVectorX:andY:at: -
– setBooleanVectorX:andY:andZ:at: -
– setBooleanVectorX:andY:andZ:andW:at: -
– setColor4B: -
– setColor4B:at: -
– setColor4F: -
– setColor4F:at: -
– setValueFromUniform: -
– valueDescription -
– updateGLValueWithVisitor:
Properties
type
Returns a symbolic constant indicating the type of content held by this variable.
@property (nonatomic, readonly) GLenum typeDiscussion
The returned value will be one of the following symbolic constants: – GL_FLOAT, GL_FLOAT_VEC2, GL_FLOAT_VEC3, GL_FLOAT_VEC4, – GL_INT, GL_INT_VEC2, GL_INT_VEC3, GL_INT_VEC4, – GL_BOOL, GL_BOOL_VEC2, GL_BOOL_VEC3, GL_BOOL_VEC4, – GL_FLOAT_MAT2, GL_FLOAT_MAT3, GL_FLOAT_MAT4, – GL_SAMPLER_2D, GL_SAMPLER_CUBE
Declared In
CC3GLSLVariable.hInstance Methods
setBoolean:
Sets the value of this uniform to the specified value.
- (void)setBoolean:(BOOL)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the boolean is converted to a float. If the type property indicates a vector type with more than one component, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetBoolean:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setBoolean:(BOOL)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the boolean is converted to a float. If the type property indicates a vector type with more than one component, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:
Sets the value of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bYDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with more than two components, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:andZ:
Sets the value of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bY andZ:(BOOL)bZDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, fourth component is set to zero.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:andZ:andW:
Sets the value of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bY andZ:(BOOL)bZ andW:(BOOL)bWDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:andZ:andW:at:
Sets the element at the specified index of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bY andZ:(BOOL)bZ andW:(BOOL)bW at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:andZ:at:
Sets the element at the specified index of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bY andZ:(BOOL)bZ at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, fourth component is set to zero.
Declared In
CC3GLSLVariable.hsetBooleanVectorX:andY:at:
Sets the element at the specified index of this boolean vector uniform to the specified value.
- (void)setBooleanVectorX:(BOOL)bX andY:(BOOL)bY at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the booleans are converted to floats. If the type property indicates a scalar, the X component is used. If the type property indicates a vector type with more than two components, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetColor4B:
Sets the value of this uniform to the specified value.
- (void)setColor4B:(ccColor4B)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an float type, the integers are normalized to floats between 0 and 1. If the type property indicates a scalar, the R component of the specified color is used. If the type property indicates a vector type with fewer than four components, the R & G, or R, G & B components are used.
Declared In
CC3GLSLVariable.hsetColor4B:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setColor4B:(ccColor4B)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an float type, the integers are normalized to floats between 0 and 1. If the type property indicates a scalar, the R component of the specified color is used. If the type property indicates a vector type with fewer than four components, the R & G, or R, G & B components are used.
Declared In
CC3GLSLVariable.hsetColor4F:
Sets the value of this uniform to the specified value.
- (void)setColor4F:(ccColor4F)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers in the range 0 to 255. If the type property indicates a scalar, the R component of the specified color is used. If the type property indicates a vector type with fewer than four components, the R & G, or R, G & B components are used.
Declared In
CC3GLSLVariable.hsetColor4F:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setColor4F:(ccColor4F)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers in the range 0 to 255. If the type property indicates a scalar, the R component of the specified color is used. If the type property indicates a vector type with fewer than four components, the R & G, or R, G & B components are used.
Declared In
CC3GLSLVariable.hsetFloat:
Sets the value of this uniform to the specified value.
- (void)setFloat:(GLfloat)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the float is converted to an integer. If the type property indicates a vector type with more than one component, the second and third components are set to zero and the fourth component is set to one.
Declared In
CC3GLSLVariable.hsetFloat:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setFloat:(GLfloat)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the float is converted to an integer. If the type property indicates a vector type with more than one component, the second and third components are set to zero and the fourth component is set to one.
Declared In
CC3GLSLVariable.hsetIntPoint:
Sets the value of this uniform to the specified value.
- (void)setIntPoint:(CC3IntPoint)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integer is converted to a float. If the type property indicates a scalar, the X component of the specified point is used. If the type property indicates a vector type with more than two components, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetIntPoint:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setIntPoint:(CC3IntPoint)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integers are converted to floats. If the type property indicates a scalar, the X component of the specified point is used. If the type property indicates a vector type with more than two components, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetIntVector4:
Sets the value of this uniform to the specified value.
- (void)setIntVector4:(CC3IntVector4)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integers are converted to floats. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetIntVector4:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setIntVector4:(CC3IntVector4)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integers are converted to floats. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetIntVector:
Sets the value of this uniform to the specified value.
- (void)setIntVector:(CC3IntVector)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integers are converted to floats. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, the fourth component is set to zero.
Declared In
CC3GLSLVariable.hsetIntVector:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setIntVector:(CC3IntVector)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integers are converted to floats. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, fourth component is set to zero.
Declared In
CC3GLSLVariable.hsetInteger:
Sets the value of this uniform to the specified value.
- (void)setInteger:(GLint)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integer is converted to a float. If the type property indicates a vector type with more than one component, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetInteger:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setInteger:(GLint)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates a float type, the integer is converted to a float. If the type property indicates a vector type with more than one component, the remaining components are set to zero.
Declared In
CC3GLSLVariable.hsetMatrix3x3:
Sets the value of this uniform to the specified value.
- (void)setMatrix3x3:(const CC3Matrix3x3 *)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance must be GL_FLOAT_MAT3.
Declared In
CC3GLSLVariable.hsetMatrix3x3:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setMatrix3x3:(const CC3Matrix3x3 *)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance must be GL_FLOAT_MAT3.
Declared In
CC3GLSLVariable.hsetMatrix4x3:
Sets the 4x4 value of this uniform from the specified 4x3 value, adding the last identity row.
- (void)setMatrix4x3:(const CC3Matrix4x3 *)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance must be GL_FLOAT_MAT4.
Declared In
CC3GLSLVariable.hsetMatrix4x3:at:
Sets the 4x4 element at the specified index in this uniform to the specified 4x3 value, adding the last identity row.
- (void)setMatrix4x3:(const CC3Matrix4x3 *)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance must be GL_FLOAT_MAT4.
Declared In
CC3GLSLVariable.hsetMatrix4x4:
Sets the value of this uniform to the specified value.
- (void)setMatrix4x4:(const CC3Matrix4x4 *)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance must be GL_FLOAT_MAT4.
Declared In
CC3GLSLVariable.hsetMatrix4x4:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setMatrix4x4:(const CC3Matrix4x4 *)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance must be GL_FLOAT_MAT4.
Declared In
CC3GLSLVariable.hsetPoint:
Sets the value of this uniform to the specified value.
- (void)setPoint:(CGPoint)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified point is used. If the type property indicates a vector type with more than two components, the third component is set to zero and the fourth component is set to one.
Declared In
CC3GLSLVariable.hsetPoint:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setPoint:(CGPoint)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified point is used. If the type property indicates a vector type with more than two components, the third component is set to zero and the fourth component is set to one.
Declared In
CC3GLSLVariable.hsetQuaternion:
Sets the value of this uniform to the specified value.
- (void)setQuaternion:(CC3Quaternion)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetQuaternion:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setQuaternion:(CC3Quaternion)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetValueFromUniform:
Sets the value of this uniform from the value of the specified uniform.
- (void)setValueFromUniform:(CC3GLSLUniform *)uniformDeclared In
CC3GLSLVariable.hsetVector4:
Sets the value of this uniform to the specified value.
- (void)setVector4:(CC3Vector4)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetVector4:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setVector4:(CC3Vector4)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than four components, the X & Y, or X, Y & Z components are used.
Declared In
CC3GLSLVariable.hsetVector:
Sets the value of this uniform to the specified value.
- (void)setVector:(CC3Vector)valueDiscussion
If this uniform has been declared as an array, this method sets the value of the first element in the array.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, fourth component is set to one.
Declared In
CC3GLSLVariable.hsetVector:at:
Sets the element at the specified index in this uniform to the specified value.
- (void)setVector:(CC3Vector)value at:(GLuint)indexDiscussion
The specified index must be less than the value of the size property. This method may still be used when this uniform has not been declared as an array. In this case, the value of the size property will be one, and so the specified index must be zero.
The type property of this instance can be any value other than one of matrix types. If the type property indicates an integer type, the floats are converted to integers. If the type property indicates a scalar, the X component of the specified vector is used. If the type property indicates a vector type with fewer than three components, the X & Y components will be used. If the type property indicates a vector type with more than three components, fourth component is set to one.
Declared In
CC3GLSLVariable.hupdateGLValueWithVisitor:
Invoked during drawing, after all of the content of the variable has been set using the set… methods, in order to have the value of this variable set into the GL engine.
- (BOOL)updateGLValueWithVisitor:(CC3NodeDrawingVisitor *)visitorDiscussion
The GL engine is only updated if the content of this variable has changed. Returns whether the value has changed and was updated into the GL engine.
This method is invoked automatically during uniform population. The application normally never needs to invoke this method.
Declared In
CC3GLSLVariable.h