Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLTexture2D Class Reference

#include <Texture2D.h>

Inheritance diagram for CSLTexture2D::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Describes a 2D texture.


Member Enumeration Documentation

enum CSLTexture2D::EBlendingType
 

This enum lists all blending type supported by the texture 2D.

enum CSLTexture2D::EMappingType
 

This enum lists all mapping type supported by the texture 2D.


Member Function Documentation

SI_Float CSLTexture2D::GetAmbient   [inline]
 

Return the normalized contribution of texture pixel colors to the material ambient color.

Returns:
SI_Float Contribution of texture.

SI_Float CSLTexture2D::GetBlending   [inline]
 

Return the normalized contribution of texture attributes (ambient, diffuse, specular, transparency, reflectivity).

Returns:
SI_Float Contribution of texture attributes.

EBlendingType CSLTexture2D::GetBlendingType   [inline]
 

Return the type of blending between texture and material attributes.

Returns:
EBlendingType Blending type.

SI_Int CSLTexture2D::GetCropUMax   [inline]
 

Return the end of the cropping region in V.

Returns:
SI_Int End of the cropping region in V.

SI_Int CSLTexture2D::GetCropUMin   [inline]
 

Return the start of the cropping region in V.

Returns:
SI_Int Start of the cropping region in V.

SI_Int CSLTexture2D::GetCropVMax   [inline]
 

Return the end of the cropping region in V.

Returns:
SI_Int End of the cropping region in V.

SI_Int CSLTexture2D::GetCropVMin   [inline]
 

Return the start of the cropping region in V.

Returns:
SI_Int Start of the cropping region in V.

SI_Float CSLTexture2D::GetDiffuse   [inline]
 

Return the normalized contribution of texture pixel colors to the material diffuse color.

Returns:
SI_Float Contribution of texture.

SI_Char* CSLTexture2D::GetImageFileName   [inline]
 

Return the name of the texture's image file.

Returns:
SI_Char* Image file name.

SI_Int CSLTexture2D::GetImageHeight   [inline]
 

Return the height in pixel of the image.

Returns:
SI_Int Image height.

SI_Int CSLTexture2D::GetImageWidth   [inline]
 

Return the width in pixel of the image.

Returns:
SI_Int Image width.

EMappingType CSLTexture2D::GetMappingType   [inline]
 

Return the mapping type of the texture.

Returns:
EMappingType Mapping type.

CSIBCMatrix4x4 CSLTexture2D::GetProjectionMatrix   [inline]
 

Return the projection matrix of the texture.

Returns:
CSIBCMatrix4x4 projection matrix.

SI_Float CSLTexture2D::GetReflectivity   [inline]
 

Return the normalized contribution of texture pixel colors to the material reflectivity level.

Returns:
SI_Float Contribution of texture.

SI_Float CSLTexture2D::GetRoughness   [inline]
 

Return the bump mapping intensity and/or displacement of geometry along surface normals.

Returns:
SI_Float Bump mapping intensity.

SI_Float CSLTexture2D::GetSpecular   [inline]
 

Return the normalized contribution of texture pixel colors to the material specular color.

Returns:
SI_Float Contribution of texture.

SI_Float CSLTexture2D::GetTransparency   [inline]
 

Return the normalized contribution of texture pixel colors to the material transparency level.

Returns:
SI_Float Contribution of texture.

SI_Bool CSLTexture2D::GetUAlternate   [inline]
 

Return the flag that indicates if the texture is mirrored horizontally.

Returns:
SI_Bool U alternate state.

SI_Float CSLTexture2D::GetUOffset   [inline]
 

Return the offset of image in U.

Returns:
SI_Float Offset of image in U.

SI_Int CSLTexture2D::GetURepeat   [inline]
 

Return the number of horizontal repetitions of the image.

Returns:
SI_Int Number of horizontal repetitions.

SI_Float CSLTexture2D::GetUScale   [inline]
 

Return the scaling of image in U.

Returns:
SI_Float Scaling of image in U.

SI_Bool CSLTexture2D::GetUVSwapFlag   [inline]
 

Indicates if the U and V orientations are swapped.

Returns:
SI_Bool UV swap state.

SI_Bool CSLTexture2D::GetVAlternate   [inline]
 

Return the flag that indicates if the texture is mirrored horizontally.

Returns:
SI_Bool V alternate state.

SI_Float CSLTexture2D::GetVOffset   [inline]
 

Return the offset of image in V.

Returns:
SI_Float Offset of image in V.

SI_Int CSLTexture2D::GetVRepeat   [inline]
 

Return the number of vertical repetitions of the image.

Returns:
SI_Int Number of vertical repetitions.

SI_Float CSLTexture2D::GetVScale   [inline]
 

Return the scaling of image in V.

Returns:
SI_Float Scaling of image in V.

SI_Void CSLTexture2D::SetAmbient SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture pixel colors to the material ambient color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Void CSLTexture2D::SetBlending SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture attributes.

Parameters:
SI_Float  New contribution of texture attributes.
Returns:
None

SI_Void CSLTexture2D::SetBlendingType EBlendingType    in_Type [inline]
 

Change the type of blending between texture and material attributes.

Parameters:
EBlendingType  New blending type.
Returns:
None

SI_Void CSLTexture2D::SetCropUMax SI_Int    in_nValue [inline]
 

Change the end of the cropping region in V.

Parameters:
SI_Int  New end of the cropping region in V.
Returns:
None

SI_Void CSLTexture2D::SetCropUMin SI_Int    in_nValue [inline]
 

Change the start of the cropping region in V.

Parameters:
SI_Int  New start of the cropping region in V.
Returns:
None

SI_Void CSLTexture2D::SetCropVMax SI_Int    in_nValue [inline]
 

Change the end of the cropping region in V.

Parameters:
SI_Int  New end of the cropping region in V.
Returns:
None

SI_Void CSLTexture2D::SetCropVMin SI_Int    in_nValue [inline]
 

Change the start of the cropping region in V.

Parameters:
SI_Int  New start of the cropping region in V.
Returns:
None

SI_Void CSLTexture2D::SetDiffuse SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture pixel colors to the material diffuse color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Void CSLTexture2D::SetImageFileName SI_Char *    in_szValue [inline]
 

Change the name of the texture's image file.

Parameters:
SI_Char  * New image file name.
Returns:
None

SI_Void CSLTexture2D::SetImageHeight SI_Int    in_nValue [inline]
 

Change the height of the image.

Parameters:
SI_Int  New image height.
Returns:
None

SI_Void CSLTexture2D::SetImageWidth SI_Int    in_nValue [inline]
 

Change the width of the image.

Parameters:
SI_Int  New image width.
Returns:
None

SI_Void CSLTexture2D::SetMappingType EMappingType    in_Type [inline]
 

Change the mapping type of the texture.

Parameters:
EMappingType  New mapping type.
Returns:
None

SI_Void CSLTexture2D::SetProjectionMatrix CSIBCMatrix4x4   in_Value [inline]
 

Change the projection matrix of the texture.

Parameters:
CSIBCMatrix4x4&  New projection matrix.
Returns:
None

SI_Void CSLTexture2D::SetReflectivity SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture pixel colors to the material reflectivity level.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Void CSLTexture2D::SetRoughness SI_Float    in_fValue [inline]
 

Change the bump mapping intensity.

Parameters:
SI_Float  New bump mapping intensity.
Returns:
None

SI_Void CSLTexture2D::SetSpecular SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture pixel colors to the material specular color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Void CSLTexture2D::SetTransparency SI_Float    in_fValue [inline]
 

Change the normalized contribution of texture pixel colors to the material transparency level.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Void CSLTexture2D::SetUAlternate SI_Bool    in_bState [inline]
 

Change the flag that indicates if the texture is mirrored horizontally.

Parameters:
SI_Bool  New U alternate state.
Returns:
None

SI_Void CSLTexture2D::SetUOffset SI_Float    in_fValue [inline]
 

Change the offset of image in U.

Parameters:
SI_Float  New offset of image in U.
Returns:
None

SI_Void CSLTexture2D::SetURepeat SI_Int    in_nValue [inline]
 

Change the number of horizontal repetitions of the image.

Parameters:
SI_Int  New number of horizontal repetitions.
Returns:
None

SI_Void CSLTexture2D::SetUScale SI_Float    in_fValue [inline]
 

Change the scaling of image in U.

Parameters:
SI_Float  New scaling of image in U.
Returns:
None

SI_Void CSLTexture2D::SetUVSwapFlag SI_Bool    in_bState [inline]
 

Change the U and V orientations swapping state.

Parameters:
SI_Bool  New UV swap state.
Returns:
None

SI_Void CSLTexture2D::SetVAlternate SI_Bool    in_bState [inline]
 

Change the flag that indicates if the texture is mirrored horizontally.

Parameters:
SI_Bool  New V alternate state.
Returns:
None

SI_Void CSLTexture2D::SetVOffset SI_Float    in_fValue [inline]
 

Change the offset of image in V.

Parameters:
SI_Float  New offset of image in V.
Returns:
None

SI_Void CSLTexture2D::SetVRepeat SI_Int    in_nValue [inline]
 

Change the number of vertical repetitions of the image.

Parameters:
SI_Int  New number of vertical repetitions.
Returns:
None

SI_Void CSLTexture2D::SetVScale SI_Float    in_fValue [inline]
 

Change the scaling of image in V.

Parameters:
SI_Float  New scaling of image in V.
Returns:
None

virtual ETemplateType CSLTexture2D::Type   [inline, virtual]
 

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Reimplemented from CSLTemplate.


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.