IRTSExecutionState Class Reference

#include <XSI_rtshaders.h>

List of all members.

Public Member Functions
virtual XSI_RTS_SystemParams *	GetSystemParams ()=0
virtual CRTSStateList *	GetStateList ()=0
virtual void *	GetShader ()=0
virtual void *	GetShaderInstanceData ()=0
virtual void	SetShaderInstanceData (void *in_pData)=0
virtual void *	GetShaderParameters ()=0
virtual long	GetShaderUniqueID ()=0
virtual eChannel	GetChannel (int in_iBuffer)=0
virtual void *	GetMaterial ()=0
virtual void *	GetPrimitive ()=0
virtual void *	GetCamera ()=0
virtual bool	DefineUniform (XSI_RTS_Uniform::eUniformType in_eType, const char *in_szName, unsigned int in_uiSize, void *in_pData)=0
virtual bool	ClearUniforms ()=0
virtual unsigned long	GetNbUniforms ()=0
virtual XSI_RTS_Uniform **	GetUniformList ()=0
virtual bool	DrawGeometry (eGraphicsAPI in_eAPI, XSI_RTS_Primitive *in_pGeometry, XSI_RTS_Attribute *in_pAttributes, void *in_pAttribData, XSI_RTS_Attribute_Size *in_pAttributesSize)=0
virtual bool	DrawGeometry (eGraphicsAPI in_eAPI, XSI_RTS_Primitive *in_pGeometry, const char *in_szMapping, void *in_pAttribData, XSI_RTS_Attribute_Size *in_pAttributesSize)=0
virtual XSI_RTS_Attribute *	GetAttributeDescriptorFromMapping (const char *in_szMapping)=0
virtual void	RaiseError (const char *in_szError, eErrorType in_eErrorType)=0
virtual void	RaiseError (const char *in_szError, eErrorType in_eErrorType, int in_Parameter, ULONG_PTR in_lData)=0
virtual void	PushExecutionState ()=0
virtual void	PopExecutionState ()=0
virtual void *	GetGraphicsAPI (eGraphicsAPI in_eAPI)=0
virtual eRenderMode	GetRenderMode ()=0

Detailed Description

You can use this object to access the following scene data (the pointer will be cached and returned to you):

• the current Camera object (see IRTSExecutionState::GetCamera)
• the Material (see IRTSExecutionState::GetMaterial)
• the Shader (see IRTSExecutionState::GetShader) and its parameters (IRTSExecutionState::GetShaderParameters)

• access the legacy tagXSI_RTS_SystemParams object (see IRTSExecutionState::GetSystemParams)
• manage uniform parameters for vertex and fragment shaders (IRTSExecutionState::DefineUniform, IRTSExecutionState::ClearUniforms, IRTSExecutionState::GetUniformList, etc.)
• render geometry during a real-time shader call using either OpenGL or DirectX (see IRTSExecutionState::GetChannel, IRTSExecutionState::DrawGeometry)
• raise errors and warnings back to Softimage

Note:

You cannot instantiate a IRTSExecutionState object directly. You can access an instance via one of the Realtime Shader Callbacks functions.

See also:

tagXSI_RTS_SystemParams, CRTSStateList, XSI_RTS_Uniform, eGraphicsAPI, tagXSI_RTS_Primitive, _XSI_RTS_Attribute, Realtime Shader Callbacks, Execution Flow

Since:

7.0

Member Function Documentation

Returns the list of executions states

Returns:

A pointer to the CRTSStateList structure

See also:

CRTSState

Returns a pointer to the SDK shader object.

Returns:

A pointer to the Shader object

See also:

IRTSExecutionState::GetShaderParameters

Returns a pointer to the user data attached to this shader instance.

Returns:

A pointer to the shader instance data

See also:

IRTSExecutionState::SetShaderInstanceData

Attaches user data to this instance of the shader.

Parameters:

in_pData

A pointer to the shader instance data

See also:

IRTSExecutionState::GetShaderInstanceData

Returns a pointer to the shader parameters (ie. the PPG values)

Returns:

A pointer to the Parameter objects

See also:

IRTSExecutionState::GetShader

Returns a unique identifier for this instance of the shader

Returns:

The shader ID

Returns the RenderChannel information associated to the specified Framebuffer object.

Parameters:

in_iBuffer

Index of the Framebuffer object. If not specified, the current buffer will be used.

Returns:

A value corresponding to one of the enum values

Returns a pointer to the SDK material object.

Returns:

A pointer to the Material object

Returns a pointer to the SDK primitive object.

Returns:

A pointer to the X3DObject object

Returns a pointer to the current SDK camera object

Returns:

A pointer to the Camera object

Defines a single uniform parameter to be used in the Realtime Shader chain.

Parameters:

	in_eType	Type of the uniform parameter
	in_szName	Name of the uniform parameter
	in_uiSize	Size of the uniform parameter
	in_pData	Pointer to the data for the uniform parameter

Returns:

Success/failure

See also:

XSI_RTS_Uniform, IRTSExecutionState::ClearUniforms, IRTSExecutionState::GetNbUniforms, IRTSExecutionState::GetUniformList

Removes all uniform parameters defined for this Realtime Shader chain.

Returns:

Success/failure

See also:

XSI_RTS_Uniform, IRTSExecutionState::DefineUniform, IRTSExecutionState::GetNbUniforms, IRTSExecutionState::GetUniformList

Returns the number of uniform parameters defined for this Realtime Shader chain.

Returns:

Size of uniform parameter list

See also:

XSI_RTS_Uniform, IRTSExecutionState::DefineUniform, IRTSExecutionState::ClearUniforms, IRTSExecutionState::GetUniformList

Returns the array of uniform parameters defined for this Realtime Shader chain.

Returns:

A pointer to the list of uniform parameters

See also:

XSI_RTS_Uniform, IRTSExecutionState::DefineUniform, IRTSExecutionState::ClearUniforms, IRTSExecutionState::GetUniformList

Draws the geometry using a list of attributes. You may explicitly suggest a graphics API to use for rendering (OpenGL20, OpenGL30, DirectX10); however, if the current viewport mode does not match your request, no rendering will occur.

Tip:

To avoid this and to be certain that your rendering call will succeed, you may use the enum value Any. This tells Softimage to use the viewport's current driver to render the geometry.

Parameters:

	in_eAPI	The graphics API to use for rendering
	in_pGeometry	Pointer to the geometry to draw
	in_pAttributes	Pointer to the attributes to use
	in_pAttribData	Pointer to the attribute data
	in_pAttributesSize	Pointer to the size of the attributes

Returns:

Success/failure

See also:

eGraphicsAPI, tagXSI_RTS_Primitive, _XSI_RTS_Attribute, eXSI_Attribute_Size, Geometry Data

Draws the geometry using a custom mapping of attributes to hardware registers.

Tip:

To avoid this and to be certain that your rendering call will succeed, you may use the enum value Any. This tells Softimage to use the viewport's current driver to render the geometry.

Parameters:

	in_eAPI	The graphics API to use for rendering
	in_pGeometry	Pointer to the geometry to draw
	in_szMapping	Custom mapping to use
	in_pAttribData	Pointer to the attribute data
	in_pAttributesSize	Pointer to the size of the attributes

Returns:

Success/failure

See also:

eGraphicsAPI, tagXSI_RTS_Primitive, eXSI_Attribute_Size, Geometry Data

Returns a list of attributes specified in the mapping.

Parameters:

in_szMapping

Custom mapping to use

Returns:

A pointer to the attributes list

See also:

eGraphicsAPI, _XSI_RTS_Attribute

Notifies Softimage to raise an error.

Parameters:

	in_szError	The error message to display
	in_eErrorType	The severity of the error to raise (similar to

See also:

eErrorType

Notifies Softimage to raise an error. Use this function to define a parameter

Parameters:

	in_szError	The error message to display
	in_eErrorType	The severity of the error to raise (similar to
	in_Parameter	??
	in_lData	??

See also:

eErrorType

Saves all states (currently only vertex and fragment shaders)

See also:

IRTSExecutionState::PopExecutionState

Restores previously pushed states (currently only vertex and fragment shaders)

See also:

IRTSExecutionState::PushExecutionState

Returns an interface to the specified graphics. API as follows:

Parameters:

in_eAPI

The graphics API to use for rendering

Returns:

for OpenGL, it returns a pointer to the main HGLRC

for DirectX_9, it returns a pointer to a IDirect3DDevice9

for DirectX_10, it returns a pointer to a ID3D10Device

See also:

eGraphicsAPI

Returns the current render mode

Returns:

the render mode

See also:

eRenderMode

Since:

7.0

• XSI_rtshaders.h