VOLVISIMAGE Struct Reference

Public Member Functions
VOLVISIMAGE &	operator= (const VOLVISIMAGE &r)
	VOLVISIMAGE (const VOLVISIMAGE &r)

Public Attributes
signed int	ChangeStamp
ENUM_CLUSTER_PARAM	ClusterParam
signed int	CompressionParam
ENUM_COMPRESSION_TYPE	CompressionType
DATABYTE *	Data
signed int	DataSize
signed int	Height
signed int	Phase
signed int	Pitch
ENUM_RENDER_STAGE	Stage
STRETCH_PARAM	Stretch
signed int	TimetoRenderFrame
ENUM_IMAGE_TYPE	Type
signed int	Width

Detailed Description

Object that describes an image rendered by a rendering engine.

Member Data Documentation

signed int VOLVISIMAGE::ChangeStamp

Reserved.

ENUM_CLUSTER_PARAM VOLVISIMAGE::ClusterParam

Specifies the clustering parameters for clustered rendering. As of this writing, clustering is not recommended because current hardware is more than capable of providing acceptable image quality for at least one client.

signed int VOLVISIMAGE::CompressionParam

Compression parameter for JPEG compression (0 = most JPEG artifacts with smallest size...100 = least JPEG artifacts with largest size).

ENUM_COMPRESSION_TYPE VOLVISIMAGE::CompressionType

Valid only in client/server APIs. Only COMPRESSION_TYPE_NONE, _JPEG and _STRETCH are currently supported.

DATABYTE* VOLVISIMAGE::Data

Pointer to data.

Pointer to data. In all cases when image is not compressed the size of the data is equal to Width * Height * BytePerPixel. The size per pixel depends on the image type, which is stored in Type variable.

Do not allocate this buffer directly. Use IImageUtil::ImageAlloc() and IImageUtil::ImageFree to manage the memory for this buffer.

signed int VOLVISIMAGE::DataSize

The total number of bytes in the Data buffer.

signed int VOLVISIMAGE::Height

The image height.

signed int VOLVISIMAGE::Phase

Current phase this image is created from (only valid for 4D images)

signed int VOLVISIMAGE::Pitch

The distance in bytes to next line in the image. Note that is is not necessarily the width multiplied by the number of bytes per pixel. There may be padding on the right side of the image.

ENUM_RENDER_STAGE VOLVISIMAGE::Stage

The rendering stage should be RENDER_STAGE_PROGR0 for interactive renders and RENDER_STAGE_FINAL for final renders.

STRETCH_PARAM VOLVISIMAGE::Stretch

Stretch parameters used internally for the COMPRESSION_TYPE_STRETCH CompressionType.

signed int VOLVISIMAGE::TimetoRenderFrame

The time taken to render this frame in micro seconds

ENUM_IMAGE_TYPE VOLVISIMAGE::Type

The image type. All rendering modes other than RT_THIN_* modes output IMAGE_TYPE_RGB images. By default, RT_THIN_* rendering modes output IMAGE_TYPE_LUMINANCE8 (8-bit grayscale). If you specify IMAGE_TYPE_LUMINANCE12 in the request VOLVISIMAGE of a render, you will get that type back instead. Despite how it is named, this image will have 16-bit pixel values that are un-windowed original scalar values from the internal dataset storage type.

signed int VOLVISIMAGE::Width

The image width.