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

The IConstantBuffer property interface.

This interface provides properties common to a class representing an array of individual uniform variables, grouped together in order to quickly activate them for a shader program.


Table members

Inherited


Murl.Graph.IUniformContainer

Methods


GetIndex()

Get the zero-based index of this constant buffer.

Integer GetIndex()

Returns
Integer The constant buffer's index inside the parent container.

GetName()

Get the constant buffer's name.

String GetName()

Returns
String The name.

GetItem()

Get the constant buffer's predefined item. If the constant buffer is a user-defined one, this method always returns IEnums::CONSTANT_BUFFER_ITEM_CUSTOM.

Murl.IEnums.ConstantBufferItem GetItem()

Returns
Murl.IEnums.ConstantBufferItem The constant buffer item.

SetMaxByteSize(maxByteSize, preserveContents)

Set the maximum byte size of the constant buffer.

Boolean SetMaxByteSize(Integer maxByteSize, Boolean preserveContents)

Parameters
maxByteSizeThe maximum capacity in bytes.
preserveContentsIf true, existing contents will be copied; but existing data beyond the new capacity is discarded.
Returns
Boolean true if successful.

GetMaxByteSize()

Get the maximum capacity of the constant buffer in bytes.

Integer GetMaxByteSize()

Returns
Integer The maximum capacity.

SetByteSize(byteSize)

Set the total byte size of all variables in the constant buffer.

Boolean SetByteSize(Integer byteSize)

Parameters
byteSizeThe currently used total number of bytes for all variables.
Returns
Boolean true if successful.

GetByteSize()

Get the total byte size of all variables in the constant buffer.

Integer GetByteSize()

Returns
Integer The currently used total number of bytes for all variables.

SetConstantsModified()

Mark the constant buffer as modified.

Boolean SetConstantsModified()

Returns
Boolean true if successful.