Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLShaderConnectionPoint Class Reference

#include <ShaderConnectionPoint.h>

Inheritance diagram for CSLShaderConnectionPoint::

CSLConnectionPoint List of all members.

Public Types

Public Methods


Detailed Description

CSLShaderConnectionPoint Class

Class representing shader connection points


Member Enumeration Documentation

enum CSLShaderConnectionPoint::EConnectionType
 

Type of connection point.

Enumeration values:
SI_SHADER  Shader connection
SI_IMAGE  Image connection
SI_NONE  No connection


Constructor & Destructor Documentation

CSLShaderConnectionPoint::CSLShaderConnectionPoint CdotXSITemplate   in_pTemplate,
SI_Int    in_nValueIndex
 

Constructor

Parameters:
in_pTemplate  Parent Template
m in_nValueIndex Index


Member Function Documentation

CSLShaderConnectionPoint::EConnectionType CSLShaderConnectionPoint::GetConnectionType  
 

Gets the type of the connection point

Returns:
EType The type of connection

SI_Char * CSLShaderConnectionPoint::GetImage  
 

Gets the name of the source image

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

SI_Error CSLShaderConnectionPoint::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_Error CSLShaderConnectionPoint::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 files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.