CSLShaderConnectionPoint Class Reference

#include <ShaderConnectionPoint.h>

Inheritance diagram for CSLShaderConnectionPoint:

CSLConnectionPoint List of all members.

Public Types
enum   EConnectionType {
  SI_SHADER,
  SI_IMAGE,
  SI_NONE
}
  Type of connection point. More...

Public Member Functions
  CSLShaderConnectionPoint (CdotXSITemplate *in_pTemplate, SI_Int in_nValueIndex)
virtual  ~CSLShaderConnectionPoint ()
  Destructor.
EConnectionType  GetConnectionType ()
SI_Error  SetImage (SI_Char *in_szName)
SI_Char *  GetImage ()
virtual SI_Error  Synchronize ()

Detailed Description

Represents shader connection points.

Member Enumeration Documentation

enum EConnectionType

Type of connection point.

Enumerator:
SI_SHADER  Shader connection
SI_IMAGE  Image connection
SI_NONE  No connection

Constructor & Destructor Documentation

CSLShaderConnectionPoint ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nValueIndex  
)

Constructor

Parameters:
in_pTemplate  Parent Template in_nValueIndex Index

Member Function Documentation

EConnectionType GetConnectionType (  ) 

Gets the type of the connection point

Returns:
EType The type of connection

SI_Error SetImage ( SI_Char *  in_szName  ) 

Sets the name of the source image

Parameters:
in_szName  Name of the source image
Returns:
SI_Error This function fails if the connection type is different than SI_IMAGE

SI_Char* GetImage (  ) 

Gets the name of the source image

Returns:
SI_Char Name of the source image or null if there's no source image

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this connection point instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLConnectionPoint.

The documentation for this class was generated from the following file: