domFx_surface_common_complexType Class Reference

#include <domFx_surface_common.h>

Inheritance diagram for domFx_surface_common_complexType:
Inheritance graph
[legend]

List of all members.

Classes

class  domFormat
class  domMip_levels
class  domMipmap_generate
class  domSize
class  domViewport_ratio

Public Types

typedef daeTArray< domFormatRefdomFormat_Array
typedef daeSmartRef< domFormatdomFormatRef
typedef daeTArray
< domMip_levelsRef
domMip_levels_Array
typedef daeSmartRef
< domMip_levels
domMip_levelsRef
typedef daeTArray
< domMipmap_generateRef
domMipmap_generate_Array
typedef daeSmartRef
< domMipmap_generate
domMipmap_generateRef
typedef daeTArray< domSizeRefdomSize_Array
typedef daeSmartRef< domSizedomSizeRef
typedef daeTArray
< domViewport_ratioRef
domViewport_ratio_Array
typedef daeSmartRef
< domViewport_ratio
domViewport_ratioRef

Public Member Functions

const daeElementRefArraygetContents () const
daeElementRefArraygetContents ()
const domExtra_ArraygetExtra_array () const
domExtra_ArraygetExtra_array ()
const domFormatRef getFormat () const
const
domFx_surface_format_hint_commonRef 
getFormat_hint () const
const domFx_surface_init_commonRef getFx_surface_init_common () const
const domMip_levelsRef getMip_levels () const
const domMipmap_generateRef getMipmap_generate () const
const domSizeRef getSize () const
domFx_surface_type_enum getType () const
const domViewport_ratioRef getViewport_ratio () const
void setType (domFx_surface_type_enum atType)

Protected Member Functions

 domFx_surface_common_complexType (DAE &dae, daeElement *elt)
virtual
domFx_surface_common_complexType
operator= (const domFx_surface_common_complexType &cpy)
virtual ~domFx_surface_common_complexType ()

Protected Attributes

daeTArray< daeCharArray * > _CMData
daeElementRefArray _contents
daeUIntArray _contentsOrder
domFx_surface_type_enum attrType
domExtra_Array elemExtra_array
domFormatRef elemFormat
domFx_surface_format_hint_commonRef elemFormat_hint
domFx_surface_init_commonRef elemFx_surface_init_common
domMip_levelsRef elemMip_levels
domMipmap_generateRef elemMipmap_generate
domSizeRef elemSize
domViewport_ratioRef elemViewport_ratio

Detailed Description

The fx_surface_common type is used to declare a resource that can be used both as the source for texture samples and as the target of a rendering pass.

Definition at line 26 of file domFx_surface_common.h.


Member Typedef Documentation

Definition at line 32 of file domFx_surface_common.h.

Definition at line 29 of file domFx_surface_common.h.

Definition at line 229 of file domFx_surface_common.h.

Definition at line 226 of file domFx_surface_common.h.

Definition at line 294 of file domFx_surface_common.h.

Definition at line 291 of file domFx_surface_common.h.

Definition at line 96 of file domFx_surface_common.h.

Definition at line 93 of file domFx_surface_common.h.

Definition at line 162 of file domFx_surface_common.h.

Definition at line 159 of file domFx_surface_common.h.


Constructor & Destructor Documentation

domFx_surface_common_complexType::domFx_surface_common_complexType ( DAE dae,
daeElement elt 
) [inline, protected]

Constructor

Definition at line 501 of file domFx_surface_common.h.

virtual domFx_surface_common_complexType::~domFx_surface_common_complexType (  )  [inline, protected, virtual]

Destructor

Definition at line 505 of file domFx_surface_common.h.


Member Function Documentation

const daeElementRefArray& domFx_surface_common_complexType::getContents (  )  const [inline]

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

Definition at line 495 of file domFx_surface_common.h.

daeElementRefArray& domFx_surface_common_complexType::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 490 of file domFx_surface_common.h.

const domExtra_Array& domFx_surface_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 485 of file domFx_surface_common.h.

domExtra_Array& domFx_surface_common_complexType::getExtra_array (  )  [inline]

Gets the extra element array.

Returns:
Returns a reference to the array of extra elements.

Definition at line 480 of file domFx_surface_common.h.

const domFormatRef domFx_surface_common_complexType::getFormat (  )  const [inline]

Gets the format element.

Returns:
a daeSmartRef to the format element.

Definition at line 450 of file domFx_surface_common.h.

const domFx_surface_format_hint_commonRef domFx_surface_common_complexType::getFormat_hint (  )  const [inline]

Gets the format_hint element.

Returns:
a daeSmartRef to the format_hint element.

Definition at line 455 of file domFx_surface_common.h.

const domFx_surface_init_commonRef domFx_surface_common_complexType::getFx_surface_init_common (  )  const [inline]

Gets the fx_surface_init_common element.

Returns:
a daeSmartRef to the fx_surface_init_common element.

Definition at line 445 of file domFx_surface_common.h.

const domMip_levelsRef domFx_surface_common_complexType::getMip_levels (  )  const [inline]

Gets the mip_levels element.

Returns:
a daeSmartRef to the mip_levels element.

Definition at line 470 of file domFx_surface_common.h.

const domMipmap_generateRef domFx_surface_common_complexType::getMipmap_generate (  )  const [inline]

Gets the mipmap_generate element.

Returns:
a daeSmartRef to the mipmap_generate element.

Definition at line 475 of file domFx_surface_common.h.

const domSizeRef domFx_surface_common_complexType::getSize (  )  const [inline]

Gets the size element.

Returns:
a daeSmartRef to the size element.

Definition at line 460 of file domFx_surface_common.h.

domFx_surface_type_enum domFx_surface_common_complexType::getType (  )  const [inline]

Gets the type attribute.

Returns:
Returns a domFx_surface_type_enum of the type attribute.

Reimplemented in domFx_surface_common.

Definition at line 434 of file domFx_surface_common.h.

const domViewport_ratioRef domFx_surface_common_complexType::getViewport_ratio (  )  const [inline]

Gets the viewport_ratio element.

Returns:
a daeSmartRef to the viewport_ratio element.

Definition at line 465 of file domFx_surface_common.h.

virtual domFx_surface_common_complexType& domFx_surface_common_complexType::operator= ( const domFx_surface_common_complexType cpy  )  [inline, protected, virtual]

Overloaded assignment operator

Definition at line 509 of file domFx_surface_common.h.

void domFx_surface_common_complexType::setType ( domFx_surface_type_enum  atType  )  [inline]

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

Reimplemented in domFx_surface_common.

Definition at line 439 of file domFx_surface_common.h.


Member Data Documentation

Used to store information needed for some content model objects.

Definition at line 426 of file domFx_surface_common.h.

Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Definition at line 417 of file domFx_surface_common.h.

Used to preserve order in elements that have a complex content model.

Definition at line 421 of file domFx_surface_common.h.

Specifying the type of a surface is mandatory though the type may be "UNTYPED". When a surface is typed as UNTYPED, it is said to be temporarily untyped and instead will be typed later by the context it is used in such as which samplers reference it in that are used in a particular technique or pass. If there is a type mismatch between what is set into it later and what the runtime decides the type should be the result in profile and platform specific behavior.

Definition at line 366 of file domFx_surface_common.h.

Definition at line 413 of file domFx_surface_common.h.

Contains a string representing the profile and platform specific texel format that the author would like this surface to use. If this element is not specified then the application will use a common format R8G8B8A8 with linear color gradient, not sRGB.

See also:
domFormat

Definition at line 382 of file domFx_surface_common.h.

If the exact format cannot be resolved via the "format" element then the format_hint will describe the important features of the format so that the application may select a compatable or close format

See also:
domFormat_hint

Definition at line 388 of file domFx_surface_common.h.

The common set of initalization options for surfaces. Choose which is appropriate for your surface based on the type attribute and other characteristics described by the annotation docs on the choiced child elements of this type.

See also:
domFx_surface_init_common

Definition at line 375 of file domFx_surface_common.h.

the surface should contain the following number of MIP levels. If this element is not present it is assumed that all miplevels exist until a dimension becomes 1 texel. To create a surface that has only one level of mip maps (mip=0) set this to 1. If the value is 0 the result is the same as if mip_levels was unspecified, all possible mip_levels will exist.

See also:
domMip_levels

Definition at line 405 of file domFx_surface_common.h.

By default it is assumed that mipmaps are supplied by the author so, if not all subsurfaces are initialized, it is invalid and will result in profile and platform specific behavior unless mipmap_generate is responsible for initializing the remainder of the sub-surfaces

See also:
domMipmap_generate

Definition at line 412 of file domFx_surface_common.h.

The surface should be sized to these exact dimensions

See also:
domSize

Definition at line 392 of file domFx_surface_common.h.

The surface should be sized to a dimension based on this ratio of the viewport's dimensions in pixels

See also:
domViewport_ratio

Definition at line 397 of file domFx_surface_common.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


colladadom
Author(s): Du Hung Hou, Khronos.org, Marcus Barnes, Greg Corson, Herbert Law, Sebastian Schwarz, Steven Thomas, John Hsu (ros package), Tim Field (ros package)
autogenerated on Fri Jan 11 09:30:22 2013