# CSLXSITextureLayer Class Reference

`#include <XSITextureLayer.h>`

Inheritance diagram for CSLXSITextureLayer:

List of all members.

## Public Member Functions
| CSLXSITextureLayer (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual | ~CSLXSITextureLayer ()
| Destructor.
SI_Error | Synchronize ()
ETemplateType | Type ()
virtual CSLAnimatableType * | ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType * | ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
SI_Int | GetOrder ()
SI_Void | SetOrder (SI_Int in_nValue)
SI_Bool | GetMute ()
SI_Void | SetMute (SI_Bool in_bValue)
SI_Bool | GetSolo ()
SI_Void | SetSolo (SI_Bool in_bValue)
SI_Char * | GetColorConnection ()
SI_Void | SetColorConnection (SI_Char *in_pValue)
SI_Float | GetRed ()
SI_Void | SetRed (SI_Float in_fValue)
SI_Float | GetGreen ()
SI_Void | SetGreen (SI_Float in_fValue)
SI_Float | GetBlue ()
SI_Void | SetBlue (SI_Float in_fValue)
SI_Float | GetAlpha ()
SI_Void | SetAlpha (SI_Float in_fValue)
SI_Bool | GetColorPremultiplied ()
SI_Void | SetColorPremultiplied (SI_Bool in_bValue)
SI_Bool | GetIgnoreColorAlpha ()
SI_Void | SetIgnoreColorAlpha (SI_Bool in_bValue)
SI_Bool | GetInvertColorAlpha ()
SI_Void | SetInvertColorAlpha (SI_Bool in_bValue)
SI_Bool | GetAlphaColor ()
SI_Void | SetAlphaColor (SI_Bool in_bValue)
SI_Char * | GetMaskConnection ()
SI_Void | SetMaskConnection (SI_Char *in_pValue)
SI_Float | GetMask ()
SI_Void | SetMask (SI_Float in_fValue)
SI_Bool | GetInvertMask ()
SI_Void | SetInvertMask (SI_Bool in_bValue)
SI_Int | GetMaskMode ()
SI_Void | SetMaskMode (SI_Int in_nValue)
SI_Float | GetMaskThreshold ()
SI_Void | SetMaskThreshold (SI_Float in_fValue)
SI_Float | GetWeight ()
SI_Void | SetWeight (SI_Float in_fValue)
SI_Int | GetMode ()
SI_Void | SetMode (SI_Int in_nValue)
CSLXSITextureLayerPort * | AddTextureLayerPort ()
SI_Error | RemoveTextureLayerPort (SI_Int in_nIndex)
SI_Error | RemoveTextureLayerPort (CSLXSITextureLayerPort *in_pToRemove)
CSLXSITextureLayerPort * | GetTextureLayerPort (SI_Int in_nIndex)
SI_Int | GetTextureLayerPortCount ()
SI_Error | ClearTextureLayerPorts ()
CSLXSITextureLayerPort ** | GetTextureLayerPortList ()
CSLXSITextureLayerPort * | ConnectTextureLayerPort (CSLXSITextureLayerPort *in_pToConnect)
CSLXSIShaderMultiPortConnection * | AddMultiPortConnection ()
SI_Error | RemoveMultiPortConnection (SI_Int in_nIndex)
SI_Error | RemoveMultiPortConnection (CSLXSIShaderMultiPortConnection *in_pToRemove)
CSLXSIShaderMultiPortConnection * | GetMultiPortConnection (SI_Int in_nIndex)
SI_Int | GetMultiPortConnectionCount ()
SI_Error | ClearMultiPortConnections ()
CSLXSIShaderMultiPortConnection ** | GetMultiPortConnectionList ()
CSLXSIShaderMultiPortConnection * | ConnectMultiPortConnection (CSLXSIShaderMultiPortConnection *in_pToConnect)
CSLXSIShaderMultiPortConnection * | FindMultiPortConnectionByParameterName (SI_Char *in_pName)

## Detailed Description

Defines more image effects (see the XSI_TextureLayer template reference).

Note:
  This template was introduced in dotXSI Version 6.0

## Constructor & Destructor Documentation

CSLXSITextureLayer | ( | CSLScene * | in_pScene,
|  | CSLModel * | in_pModel,
|  | CdotXSITemplate * | in_pTemplate |
| ) |  |  |

Constructor

Parameters:

  | in_pScene | Parent scene
  | in_pModel | Parent model
  | in_pTemplate | Referred template

## Member Function Documentation

SI_Error Synchronize | ( |  | ) | `[virtual]`

Commit the current template information

Returns:
  SI_Error Whether or not the commit was successful

Reimplemented from CSLTemplate.

ETemplateType Type | ( |  | ) | `[inline, virtual]`

Gets the type of this template

Returns:
  ETemplateType The type of this template (XSI_TEXTURE_LAYER)

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName | ( | SI_Char * | in_szName | ) | `[virtual]`

Return a proxy to the specified parameter.

Parameters:

  | in_szName | Name of the parameter

Returns:
  CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType | ( | EFCurveType | in_Type,
|  | SI_Char * | in_szParameterName |
| ) |  |  | `[virtual]`

Return a proxy to the specified parameter.

Parameters:

  | in_Type | Type of parameter
  | in_szParameterName | Name of the parameter if the type is SI_PARAMETER

Returns:
  CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Int GetOrder | ( |  | ) |

Get the Order value

Returns:
  SI_Float Order

SI_Void SetOrder | ( | SI_Int | in_nValue | ) |

Set the Order value

Parameters:

  | SI_Float | new Order value

SI_Bool GetMute | ( |  | ) |

Get the Mute value

Returns:
  SI_Float Mute

SI_Void SetMute | ( | SI_Bool | in_bValue | ) |

Set the Mute value

Parameters:

  | SI_Float | new Mute value

SI_Bool GetSolo | ( |  | ) |

Get the Solo value

Returns:
  SI_Float Solo

SI_Void SetSolo | ( | SI_Bool | in_bValue | ) |

Set the Solo value

Parameters:

  | SI_Float | new Solo value

SI_Char* GetColorConnection | ( |  | ) |

Get the ColorConnection value

Returns:
  SI_Char* ColorConnection

SI_Void SetColorConnection | ( | SI_Char * | in_pValue | ) |

Set the ColorConnection value

Parameters:

  | SI_Char* | new ColorConnection value

SI_Float GetRed | ( |  | ) |

Get the Red value

Returns:
  SI_Float Red

SI_Void SetRed | ( | SI_Float | in_fValue | ) |

Set the Red value

Parameters:

  | SI_Float | new Red value

SI_Float GetGreen | ( |  | ) |

Get the Green value

Returns:
  SI_Float Green

SI_Void SetGreen | ( | SI_Float | in_fValue | ) |

Set the Green value

Parameters:

  | SI_Float | new Green value

SI_Float GetBlue | ( |  | ) |

Get the Blue value

Returns:
  SI_Float Blue

SI_Void SetBlue | ( | SI_Float | in_fValue | ) |

Set the Blue value

Parameters:

  | SI_Float | new Blue value

SI_Float GetAlpha | ( |  | ) |

Get the Alpha value

Returns:
  SI_Float Alpha

SI_Void SetAlpha | ( | SI_Float | in_fValue | ) |

Set the Alpha value

Parameters:

  | SI_Float | new Alpha value

SI_Bool GetColorPremultiplied | ( |  | ) |

Get the ColorPremultiplied value

Returns:
  SI_Float ColorPremultiplied

SI_Void SetColorPremultiplied | ( | SI_Bool | in_bValue | ) |

Set the ColorPremultiplied value

Parameters:

  | SI_Float | new ColorPremultiplied value

SI_Bool GetIgnoreColorAlpha | ( |  | ) |

Get the IgnoreColorAlpha value

Returns:
  SI_Float IgnoreColorAlpha

SI_Void SetIgnoreColorAlpha | ( | SI_Bool | in_bValue | ) |

Set the IgnoreColorAlpha value

Parameters:

  | SI_Float | new IgnoreColorAlpha value

SI_Bool GetInvertColorAlpha | ( |  | ) |

Get the InvertColorAlpha value

Returns:
  SI_Float InvertColorAlpha

SI_Void SetInvertColorAlpha | ( | SI_Bool | in_bValue | ) |

Set the InvertColorAlpha value

Parameters:

  | SI_Float | new InvertColorAlpha value

SI_Bool GetAlphaColor | ( |  | ) |

Get the AlphaColor value

Returns:
  SI_Float AlphaColor

SI_Void SetAlphaColor | ( | SI_Bool | in_bValue | ) |

Set the AlphaColor value

Parameters:

  | SI_Float | new AlphaColor value

SI_Char* GetMaskConnection | ( |  | ) |

Get the MaskConnection value

Returns:
  SI_Char* MaskConnection

SI_Void SetMaskConnection | ( | SI_Char * | in_pValue | ) |

Set the MaskConnection value

Parameters:

  | SI_Char* | new MaskConnection value

SI_Float GetMask | ( |  | ) |

Get the Mask value

Returns:
  SI_Float Mask

SI_Void SetMask | ( | SI_Float | in_fValue | ) |

Set the Mask value

Parameters:

  | SI_Float | new Mask value

SI_Bool GetInvertMask | ( |  | ) |

Get the InvertMask value

Returns:
  SI_Float InvertMask

SI_Void SetInvertMask | ( | SI_Bool | in_bValue | ) |

Set the InvertMask value

Parameters:

  | SI_Float | new InvertMask value

SI_Int GetMaskMode | ( |  | ) |

Get the MaskMode value

Returns:
  SI_Float MaskMode

SI_Void SetMaskMode | ( | SI_Int | in_nValue | ) |

Set the MaskMode value

Parameters:

  | SI_Float | new MaskMode value

SI_Float GetMaskThreshold | ( |  | ) |

Get the MaskThreshold value

Returns:
  SI_Float MaskThreshold

SI_Void SetMaskThreshold | ( | SI_Float | in_fValue | ) |

Set the MaskThreshold value

Parameters:

  | SI_Float | new MaskThreshold value

SI_Float GetWeight | ( |  | ) |

Get the Weight value

Returns:
  SI_Float Weight

SI_Void SetWeight | ( | SI_Float | in_fValue | ) |

Set the Weight value

Parameters:

  | SI_Float | new Weight value

SI_Int GetMode | ( |  | ) |

Get the Mode value

Returns:
  SI_Float Mode

SI_Void SetMode | ( | SI_Int | in_nValue | ) |

Set the Mode value

Parameters:

  | SI_Float | new Mode value

CSLXSITextureLayerPort* AddTextureLayerPort | ( |  | ) |

Add a texture layer port to the texture layer port list

Returns:
  The added texture layer port

SI_Error RemoveTextureLayerPort | ( | SI_Int | in_nIndex | ) |

Remove a texture layer port from the texture layer port list

Parameters:

  | in_nIndex | Index of the texture layer port to remove

SI_Error RemoveTextureLayerPort | ( | CSLXSITextureLayerPort * | in_pToRemove | ) |

Remove a texture layer port from the texture layer port list

Parameters:

  | in_pToRemove | The texture layer port to remove

CSLXSITextureLayerPort* GetTextureLayerPort | ( | SI_Int | in_nIndex | ) |

Get the CSLXSITextureLayerPort object by index.

Parameters:

  | in_nIndex | Index of the texture layer port to get

Returns:
  CSLXSITextureLayerPort The CSLXSITextureLayerPort.

SI_Int GetTextureLayerPortCount | ( |  | ) |

Get the number of texture layer port in the texture layer port list

Returns:
  SI_Int The number of texture layer port in the texture layer port list

SI_Error ClearTextureLayerPorts | ( |  | ) |

Deletes all the texture layer port form the texture layer port list

CSLXSITextureLayerPort** GetTextureLayerPortList | ( |  | ) |

Gets a pointer to the internally-stored texture layer port pointer list

Returns:
  CSLXSITextureLayerPort Pointer to the list

CSLXSITextureLayerPort* ConnectTextureLayerPort | ( | CSLXSITextureLayerPort * | in_pToConnect | ) |

Adds an exisiting texture layer port to the texture layer port list

Parameters:

  | in_pToConnect | Pointer to the texture layer port to add

Returns:
  The added texture layer port

CSLXSIShaderMultiPortConnection* AddMultiPortConnection | ( |  | ) |

Add a multi port connection to the multi port connection list

Parameters:

  | in_pParameter | Name of the new multi port connection parameter
  | in_pPortName | Name of the new multi port connection port name

Returns:
  The added multi port connection

SI_Error RemoveMultiPortConnection | ( | SI_Int | in_nIndex | ) |

Remove a multi port connection from the multi port connection list

Parameters:

  | in_nIndex | Index of the multi port connection to remove

SI_Error RemoveMultiPortConnection | ( | CSLXSIShaderMultiPortConnection * | in_pToRemove | ) |

Remove a multi port connection from the multi port connection list

Parameters:

  | in_pToRemove | The multi port connection to remove

CSLXSIShaderMultiPortConnection* GetMultiPortConnection | ( | SI_Int | in_nIndex | ) |

Get the CSLXSIShaderMultiPortConnection object of a given multi port connection by index.

Parameters:

  | in_nIndex | Index of the multi port connection to get

Returns:
  CSLXSIShaderMultiPortConnection The CSLXSIShaderMultiPortConnection that holds the name and the type of a multi port connection.

SI_Int GetMultiPortConnectionCount | ( |  | ) |

Get the number of multi port connection in the multi port connection list

Returns:
  SI_Int The number of multi port connection in the multi port connection list

SI_Error ClearMultiPortConnections | ( |  | ) |

Deletes all the multi port connection form the multi port connection list

CSLXSIShaderMultiPortConnection** GetMultiPortConnectionList | ( |  | ) |

Gets a pointer to the internally-stored multi port connection pointer list

Returns:
  CSLXSIShaderMultiPortConnection Pointer to the list

CSLXSIShaderMultiPortConnection* ConnectMultiPortConnection | ( | CSLXSIShaderMultiPortConnection * | in_pToConnect | ) |

Adds an exisiting multi port connection to the multi port connection list

Parameters:

  | in_pToConnect | Pointer to the multi port connection to add

Returns:
  The added multi port connection

CSLXSIShaderMultiPortConnection* FindMultiPortConnectionByParameterName | ( | SI_Char * | in_pName | ) |

Search the multi port connection list for one with a corresponding parameter name

Parameters:

  | in_pName | The parameter name to look for

Returns:
  Pointer on the multi port connection if found, NULL if not found

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

- XSITextureLayer.h