Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLImageData Class Reference

#include <XSIImageData.h>

Inheritance diagram for CSLImageData::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class CSLImageData

Defines raw pixel information of an image.

Note:
This template was introduced in dotXSI Version 3.6


Member Typedef Documentation

typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLImageData::CSLIntArray
 

Proxy class that allows modifying a list of SI_Int like an array.


Member Enumeration Documentation

enum CSLImageData::ECompressionType
 

Defines the various compression types.

Enumeration values:
SI_UNCOMPRESSED  No compression


Constructor & Destructor Documentation

CSLImageData::CSLImageData CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

CSLImageData::ECompressionType CSLImageData::GetCompressionType  
 

Gets the compression type of the image

Returns:
ECompressionType The type of compression

SI_Int CSLImageData::GetImageDataCount  
 

Gets the size of the image data color information

Returns:
SI_Int size of the image data color information

CSLImageData::CSLIntArray * CSLImageData::GetImageDataList  
 

Get the color information array

Returns:
CSLImageDataArray Array of color information

SI_Int * CSLImageData::GetImageDataListPtr  
 

Gets a pointer to the raw color information of the image

Returns:
SI_Int Pointer to the array containing the color information

SI_Void CSLImageData::SetCompressionType CSLImageData::ECompressionType    in_Type
 

Sets the compression type of the image

Parameters:
in_Type  The type of compression

SI_Void CSLImageData::SetImageData CSIBCArray< SI_Int > &    in_Data
 

Sets the raw color information of the image

Parameters:
in_Data  Array containing the raw color information

SI_Error CSLImageData::Synchronize   [virtual]
 

Commits Semantic Layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLImageData::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_IMAGE_DATA

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.