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>

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 MString &	name () 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

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]	name	Name of the target description
[in]	width	Width in pixels
[in]	height	Height in pixels
[in]	multiSampleCount	Number of samples for a multisampled anti-aliased (MSAA) target. A value of 1 indicates no multisampling.
[in]	rasterFormat	Raster / pixel format of the target.
[in]	arraySliceCount	The number of array slices. Default value is 0 meaning a single 2D target.
[in]	isCubeMap	If true indicates that the target a cube map. The default value is false. The argument is ignored if the number of array slices is not equal to 6. If this argument is specified then the arraySliceCount is set to be 6 in the constructor.