DWFToolkit::DWFTexture Interface Reference
[DWF Publisher API]

#include "dwf/publisher/Image.h"

Collaboration diagram for DWFToolkit::DWFTexture:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a publishable texture image.

Since:
7.0.1
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 271 of file Image.h.

Public Member Functions

_DWFTK_API DWFTexture (const DWFString &zName, const DWFString &zMIMEType, unsigned char nBitsPerPixel, double nWidth, double nHeight, double *pClipRegion=NULL) throw ()
_DWFTK_API ~DWFTexture () throw ()
_DWFTK_API const DWFStringname () const throw ()


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFTexture::DWFTexture const DWFString zName,
const DWFString zMIMEType,
unsigned char  nBitsPerPixel,
double  nWidth,
double  nHeight,
double *  pClipRegion = NULL
throw () [inline]
 

Constructor

Parameters:
zName Unique name for the texture.
zMIMEType The MIME type of the image data.
nBitsPerPixel The image pixel depth.
nWidth The horizontal extent of the image in pixels.
nHeight The veritical extent of the image in pixels.
pClipRegion An optional path against which the image should be clipped when shown. This pointer is not copied; the caller must delete this memory when no longer in use.
Exceptions:
None 
Todo:
The clipping data should be copied.

Definition at line 291 of file Image.h.

_DWFTK_API DWFToolkit::DWFTexture::~DWFTexture  )  throw () [inline]
 

Destructor

Exceptions:
None 

Definition at line 313 of file Image.h.


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::DWFTexture::name  )  const throw () [inline]
 

Returns the unique name of the texture.

Returns:
The texture name.
Exceptions:
None 

Definition at line 324 of file Image.h.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:40:44 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5