domFx_surface_format_hint_common_complexType Class Reference

#include <domFx_surface_format_hint_common.h>

Inheritance diagram for domFx_surface_format_hint_common_complexType:

[legend]

List of all members.

Classes
class	domChannels
class	domOption
class	domPrecision
class	domRange
Public Types
typedef daeTArray< domChannelsRef >	domChannels_Array
typedef daeSmartRef< domChannels >	domChannelsRef
typedef daeTArray< domOptionRef >	domOption_Array
typedef daeSmartRef< domOption >	domOptionRef
typedef daeTArray < domPrecisionRef >	domPrecision_Array
typedef daeSmartRef< domPrecision >	domPrecisionRef
typedef daeTArray< domRangeRef >	domRange_Array
typedef daeSmartRef< domRange >	domRangeRef
Public Member Functions
const domChannelsRef	getChannels () const
const domExtra_Array &	getExtra_array () const
domExtra_Array &	getExtra_array ()
const domOption_Array &	getOption_array () const
domOption_Array &	getOption_array ()
const domPrecisionRef	getPrecision () const
const domRangeRef	getRange () const
Protected Member Functions
	domFx_surface_format_hint_common_complexType (DAE &dae, daeElement *elt)
virtual domFx_surface_format_hint_common_complexType &	operator= (const domFx_surface_format_hint_common_complexType &cpy)
virtual	~domFx_surface_format_hint_common_complexType ()
Protected Attributes
domChannelsRef	elemChannels
domExtra_Array	elemExtra_array
domOption_Array	elemOption_array
domPrecisionRef	elemPrecision
domRangeRef	elemRange

---

Detailed Description

If the exact format cannot be resolve via other methods then the format_hint will describe the important features of the format so that the application may select a compatable or close format

Definition at line 24 of file domFx_surface_format_hint_common.h.

---

Member Typedef Documentation

typedef daeTArray<domChannelsRef> domFx_surface_format_hint_common_complexType::domChannels_Array

Definition at line 30 of file domFx_surface_format_hint_common.h.

typedef daeSmartRef<domChannels> domFx_surface_format_hint_common_complexType::domChannelsRef

Definition at line 27 of file domFx_surface_format_hint_common.h.

typedef daeTArray<domOptionRef> domFx_surface_format_hint_common_complexType::domOption_Array

Definition at line 220 of file domFx_surface_format_hint_common.h.

typedef daeSmartRef<domOption> domFx_surface_format_hint_common_complexType::domOptionRef

Definition at line 217 of file domFx_surface_format_hint_common.h.

typedef daeTArray<domPrecisionRef> domFx_surface_format_hint_common_complexType::domPrecision_Array

Definition at line 156 of file domFx_surface_format_hint_common.h.

typedef daeSmartRef<domPrecision> domFx_surface_format_hint_common_complexType::domPrecisionRef

Definition at line 153 of file domFx_surface_format_hint_common.h.

typedef daeTArray<domRangeRef> domFx_surface_format_hint_common_complexType::domRange_Array

Definition at line 93 of file domFx_surface_format_hint_common.h.

typedef daeSmartRef<domRange> domFx_surface_format_hint_common_complexType::domRangeRef

Definition at line 90 of file domFx_surface_format_hint_common.h.

---

Constructor & Destructor Documentation

domFx_surface_format_hint_common_complexType::domFx_surface_format_hint_common_complexType	(	DAE &	dae,
		daeElement *	elt
	)			[inline, protected]

Constructor

Definition at line 348 of file domFx_surface_format_hint_common.h.

virtual domFx_surface_format_hint_common_complexType::~domFx_surface_format_hint_common_complexType

(

)

[inline, protected, virtual]

Destructor

Definition at line 352 of file domFx_surface_format_hint_common.h.

---

Member Function Documentation

const domChannelsRef domFx_surface_format_hint_common_complexType::getChannels

(

)

const [inline]

Gets the channels element.

Returns:

a daeSmartRef to the channels element.

Definition at line 313 of file domFx_surface_format_hint_common.h.

const domExtra_Array& domFx_surface_format_hint_common_complexType::getExtra_array

(

)

const [inline]

Gets the extra element array.

Returns:

Returns a constant reference to the array of extra elements.

Definition at line 343 of file domFx_surface_format_hint_common.h.

domExtra_Array& domFx_surface_format_hint_common_complexType::getExtra_array

(

)

[inline]

Gets the extra element array.

Returns:

Returns a reference to the array of extra elements.

Definition at line 338 of file domFx_surface_format_hint_common.h.

const domOption_Array& domFx_surface_format_hint_common_complexType::getOption_array

(

)

const [inline]

Gets the option element array.

Returns:

Returns a constant reference to the array of option elements.

Definition at line 333 of file domFx_surface_format_hint_common.h.

domOption_Array& domFx_surface_format_hint_common_complexType::getOption_array

(

)

[inline]

Gets the option element array.

Returns:

Returns a reference to the array of option elements.

Definition at line 328 of file domFx_surface_format_hint_common.h.

const domPrecisionRef domFx_surface_format_hint_common_complexType::getPrecision

(

)

const [inline]

Gets the precision element.

Returns:

a daeSmartRef to the precision element.

Definition at line 323 of file domFx_surface_format_hint_common.h.

const domRangeRef domFx_surface_format_hint_common_complexType::getRange

(

)

const [inline]

Gets the range element.

Returns:

a daeSmartRef to the range element.

Definition at line 318 of file domFx_surface_format_hint_common.h.

virtual domFx_surface_format_hint_common_complexType& domFx_surface_format_hint_common_complexType::operator=

(

const domFx_surface_format_hint_common_complexType &

cpy

)

[inline, protected, virtual]

Overloaded assignment operator

Definition at line 356 of file domFx_surface_format_hint_common.h.

---

Member Data Documentation

domChannelsRef domFx_surface_format_hint_common_complexType::elemChannels [protected]

The per-texel layout of the format. The length of the string indicate how many channels there are and the letter respresents the name of the channel. There are typically 0 to 4 channels.

See also:

domChannels

Definition at line 287 of file domFx_surface_format_hint_common.h.

domExtra_Array domFx_surface_format_hint_common_complexType::elemExtra_array [protected]

Definition at line 306 of file domFx_surface_format_hint_common.h.

domOption_Array domFx_surface_format_hint_common_complexType::elemOption_array [protected]

Additional hints about data relationships and other things to help the application pick the best format.

See also:

domOption

Definition at line 305 of file domFx_surface_format_hint_common.h.

domPrecisionRef domFx_surface_format_hint_common_complexType::elemPrecision [protected]

Each channel of the texel has a precision. Typically these are all linked together. An exact format lay lower the precision of an individual channel but applying a higher precision by linking the channels together may still convey the same information.

See also:

domPrecision

Definition at line 300 of file domFx_surface_format_hint_common.h.

domRangeRef domFx_surface_format_hint_common_complexType::elemRange [protected]

Each channel represents a range of values. Some example ranges are signed or unsigned integers, or between between a clamped range such as 0.0f to 1.0f, or high dynamic range via floating point

See also:

domRange

Definition at line 293 of file domFx_surface_format_hint_common.h.

---

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

• domFx_surface_format_hint_common.h