Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IConstantBufferParameter

The IConstantBufferParameter graph node interface.

A single constant buffer parameter is used in conjunction with a Graph::IShaderProgram and its referenced Graph::IShader nodes, in order to set the value of a specific custom (or predefined) uniform variable in these GPU shaders.

Each constant buffer parameter is defined by a name and data type matching the name and type of a uniform variable in the shader(s); in addition, it is possible to reference an optional parent parameter whose value can be modulated by a given arithmetic operation such as addition, replacement or multiplication.

Constant buffer parameters must be grouped together in a Graph::IConstantBufferParameterGroup, which in turn must be part of a set of groups in a Graph::IConstantBufferParameters node.

See the Graph::IUniform base interface for accessing actual uniform parameters. See Graph::IConstantBufferParameterGroup for grouping individual parameter nodes. See Graph::IConstantBufferParameters for collecting individual groups.


Table members

Inherited


Murl.Graph.IUniform

Methods


GetNodeInterface()

Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Murl.Graph.INode GetNodeInterface()

Returns
Murl.Graph.INode The constant Graph::INode interface, or null if not available

GetParentConstantBufferParameterNodeTarget()

Get the constant Graph::IConstantBufferParameter container storing the optional parent. This method returns a constant pointer to the node's Graph::IConstantBufferParameter container that stores an optional reference to another generic parameter object, to query the object's parent.

Murl.Graph.IGenericNodeTarget.GraphIConstantBufferParameter GetParentConstantBufferParameterNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphIConstantBufferParameter The constant Graph::IConstantBufferParameter parent container, or null if not available.

SetName(name)

Set the actual uniform variable name. Once initialized, the variable name cannot be changed.

Boolean SetName(String name)

Parameters
nameThe uniform name.
Returns
Boolean true if successful.

SetOperation(operation)

Set the arithmetic operation for modulating the optional parent's value.

Boolean SetOperation(Murl.IEnums.AluOperation operation)

Parameters
operationThe modulation operation.
Returns
Boolean true if successful.

SetValue(value)

Set the actual parameter value(s) by string. Sets the modified state to true if successful.

Boolean SetValue(String value)

Parameters
valueThe value(s) in string representation.
Returns
Boolean true if successful.

SetValue(value, index)

Set an actual parameter value by string and index. Sets the modified state to true if successful.

Boolean SetValue(String value, Integer index)

Parameters
valueThe value in string representation.
indexThe zero-based index to the value.
Returns
Boolean true if successful.

SetFloatValue(value, index)

Set an actual float parameter value. Sets the modified state to true if successful.

Boolean SetFloatValue(Number value, Integer index)

Parameters
valueThe value.
indexThe zero-based index to the value.
Returns
Boolean true if successful.

SetSInt32Value(value, index)

Set an actual integer parameter value. Sets the modified state to true if successful.

Boolean SetSInt32Value(Integer value, Integer index)

Parameters
valueThe value.
indexThe zero-based index to the value.
Returns
Boolean true if successful.

GetFloatValue(index)

Get an actual float parameter value.

Number GetFloatValue(Integer index)

Parameters
indexThe zero-based index to the value.
Returns
Number The value.

GetSInt32Value(index)

Get an actual integer parameter value.

Integer GetSInt32Value(Integer index)

Parameters
indexThe zero-based index to the value.
Returns
Integer The value.

GetModulatedFloatValue(index)

Get an actual modulated float parameter value.

Number GetModulatedFloatValue(Integer index)

Parameters
indexThe zero-based index to the value.
Returns
Number The modulated value.

GetModulatedSInt32Value(index)

Get an actual modulated integer parameter value.

Integer GetModulatedSInt32Value(Integer index)

Parameters
indexThe zero-based index to the value.
Returns
Integer The modulated value.

SetValueModified(isModified)

Set the modified state of the parameter value.

Boolean SetValueModified(Boolean isModified)

Parameters
isModifiedThe modified state.
Returns
Boolean true if successful.

IsValueModified()

Query the modified state of the parameter value.

Boolean IsValueModified()

Returns
Boolean The modified state.