Class which defines rendering the 2D heads-up-display. More...
#include <MViewport2Renderer.h>
Public Member Functions | |
MHUDRender () | |
Default constructor for a HUD render operation. | |
~MHUDRender () override | |
Default destructor for a HUD render operation. | |
const MString & | name () const override |
Name for a HUD render operation. More... | |
virtual bool | hasUIDrawables () const |
addUIdrawables() will be called only if this method is overridden to return true. More... | |
virtual void | addUIDrawables (MUIDrawManager &drawManager2D, const MFrameContext &frameContext) |
Provides access to the 2D version of MUIDrawManager, which can be used to queue up operations to draw simple UI shapes like lines, circles, text, etc. More... | |
![]() | |
virtual bool | enableSRGBWrite () |
Return whether to enable GPU based gamma correction during pixel writes. More... | |
virtual const MFloatPoint * | viewportRectangleOverride () |
Query for a viewport rectangle override. More... | |
virtual bool | getInputTargetDescription (const MString &name, MRenderTargetDescription &description) |
Return the description to use when creating the target for the named input. More... | |
virtual int | writableTargets (unsigned int &count) |
Return the index of the first writable target in the inputTargets list. More... | |
virtual MRenderTarget *const * | targetOverrideList (unsigned int &listSize) |
Return a list of pointers to render target which will be used as the target overrides for the operation. More... | |
const MStringArray & | inputTargets () |
An array of input target names that semantically declares the type of targets the operation requires as input. More... | |
const MStringArray & | outputTargets () |
An array of output target names that semantically declares the type of targets the operation can produce. More... | |
void | renameOutputTarget (const MString &name, const MString &newName) |
Renames an output target of an operation. More... | |
MRenderOperationType | operationType () const |
Query the type (MRenderOperationType) of a render operator. More... | |
Additional Inherited Members | |
![]() | |
enum | MRenderOperationType { kClear, kSceneRender, kQuadRender, kUserDefined, kHUDRender, kPresentTarget } |
Supported render operation types. More... | |
![]() | |
MRenderOperation (const MString &name) | |
Protected constructor. More... | |
MRenderTarget * | getInputTarget (const MString &name) |
Gets the target associated with this input. More... | |
![]() | |
MRenderOperationType | mOperationType |
Operation type. | |
MString | mName |
Identifier for a sub render. | |
Class which defines rendering the 2D heads-up-display.
|
overridevirtual |
Name for a HUD render operation.
Note that all HUD operations share the same name since they need not be distinguished from one another.
Reimplemented from MRenderOperation.
|
virtual |
addUIdrawables() will be called only if this method is overridden to return true.
The default implementation returns false.
If addUIDrawables() is not needed, this method should return false in order to avoid extra overhead required for adding UI drawables to the override.
|
virtual |
Provides access to the 2D version of MUIDrawManager, which can be used to queue up operations to draw simple UI shapes like lines, circles, text, etc.
This method will only be called when hasUIDrawables() is overridden to return true.
[in] | drawManager2D | A UI draw manager which can be used to draw simple 2D geometry, including text. When passing coordinates to the draw manager's methods, only X and Y have meaning. The origin (0, 0) is in the lower-left corner of the view. |
[in] | frameContext | Frame level context information. |