This reference page is linked to from the following overview topics: レンダリング オーバーライド(Rendering Overrides).
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. |
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.
[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. A value of 1 means a single 2D target. |
[in] | isCubeMap | A 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. |
const MString & name | ( | ) | const |
Query the name identifier for the target description.
unsigned int width | ( | ) | const |
unsigned int height | ( | ) | const |
unsigned int multiSampleCount | ( | ) | const |
Query the multi-sample count defined by the description.
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 | ) |
void setHeight | ( | unsigned int | val | ) |
void setMultiSampleCount | ( | unsigned int | val | ) |
Set multisample count of the target.
[in] | val | Sample count to set. |
void setRasterFormat | ( | MHWRender::MRasterFormat | val | ) |
void setArraySliceCount | ( | unsigned int | val | ) |
Set array slice count of the target.
[in] | val | Slice count to set. |
void setIsCubeMap | ( | bool | val | ) |
Set cube map flag for the target.
[in] | val | Cube map flag to set. |