MRenderTargetDescription Class Reference

This reference page is linked to from the following overview topics: レンダリング オーバーライド(Rendering Overrides).



Detailed Description

Class which provides a description of a hardware render target The name is the unique identifier for a render target.

#include <MRenderTargetManager.h>

List of all members.

Public Member Functions

 MRenderTargetDescription (const MString &name, unsigned int width, unsigned int height, unsigned int multiSampleCount, MHWRender::MRasterFormat rasterFormat, unsigned int arraySliceCount, bool isCubeMap)
 Constructor for a render target description.
virtual ~MRenderTargetDescription ()
 Default destructor.
const MStringname () const
 Query the name identifier for the target description.
unsigned int width () const
 Query the width of a 2D render target slice.
unsigned int height () const
 Query the height of a 2D render target slice.
unsigned int multiSampleCount () const
 Query the multi-sample count defined by the description.
MHWRender::MRasterFormat rasterFormat () const
 Query the raster format defined by the description.
unsigned int arraySliceCount () const
 Query the number of array slices defined by the description.
bool isCubeMap () const
 Query whether this is a cube map target.
void setWidth (unsigned int val)
 Set width of the target.
void setHeight (unsigned int val)
 Set height of the target.
void setMultiSampleCount (unsigned int val)
 Set multisample count of the target.
void setRasterFormat (MHWRender::MRasterFormat val)
 Set the raster format of the target.
void setArraySliceCount (unsigned int val)
 Set array slice count of the target.
void setIsCubeMap (bool val)
 Set cube map flag for the target.

Constructor & Destructor Documentation

MRenderTargetDescription ( const MString name,
unsigned int  width,
unsigned int  height,
unsigned int  multiSampleCount,
MHWRender::MRasterFormat  rasterFormat,
unsigned int  arraySliceCount,
bool  isCubeMap 
)

Constructor for a render target description.

The basic description of a 2 dimensional (2D) target is the width, height, the sample count, and the raster format.

  • Cube maps, and generalized arrays of targets can be specified by providing an array (slice) count which is greater than zero. A "slice" is logically equivalent to a 2D render target.
  • If multiple slices are specified, then an additional flag is required to distinguish between a general array of 2D targets and a one which forms a cube map.
Parameters:
[in]nameName of the target description
[in]widthWidth in pixels
[in]heightHeight in pixels
[in]multiSampleCountNumber of samples for a multisampled anti-aliased (MSAA) target. A value of 1 indicates no multisampling.
[in]rasterFormatRaster / pixel format of the target.
[in]arraySliceCountThe number of array slices. A value of 1 means a single 2D target.
[in]isCubeMapA true value indicates that the target is a cube map. In this case the arraySliceCount is set to be 6 in the constructor. The argument is ignored if the number of array slices is not equal to 6.

Member Function Documentation

const MString & name ( ) const

Query the name identifier for the target description.

Returns:
Identifier name
unsigned int width ( ) const

Query the width of a 2D render target slice.

Returns:
Width value
unsigned int height ( ) const

Query the height of a 2D render target slice.

Returns:
Height value
unsigned int multiSampleCount ( ) const

Query the multi-sample count defined by the description.

Returns:
Sample value
MRasterFormat rasterFormat ( ) const

Query the raster format defined by the description.

Returns:
The raster format.
unsigned int arraySliceCount ( ) const

Query the number of array slices defined by the description.

Returns:
The slice count
bool isCubeMap ( ) const

Query whether this is a cube map target.

Returns:
True if the target describes a cubemap.
void setWidth ( unsigned int  val)

Set width of the target.

Parameters:
[in]valWidth to set.
void setHeight ( unsigned int  val)

Set height of the target.

Parameters:
[in]valHeight to set.
void setMultiSampleCount ( unsigned int  val)

Set multisample count of the target.

Parameters:
[in]valSample count to set.
void setRasterFormat ( MHWRender::MRasterFormat  val)

Set the raster format of the target.

Parameters:
[in]valFormat to set.
void setArraySliceCount ( unsigned int  val)

Set array slice count of the target.

Parameters:
[in]valSlice count to set.
void setIsCubeMap ( bool  val)

Set cube map flag for the target.

Parameters:
[in]valCube map flag to set.

MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription
MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription MRenderTargetDescription