MHUDRender Class Reference

#include <MViewport2Renderer.h>

Class Description

+ Inheritance diagram for MHUDRender:

Public Member Functions

 MHUDRender ()
 Default constructor for a HUD render operation.
 
virtual ~MHUDRender ()
 Default destructor for a HUD render operation.
 
const MStringname () const
 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...
 
- Public Member Functions inherited from MRenderOperation
virtual bool enableSRGBWrite ()
 Return whether to enable GPU based gamma correction during pixel writes. More...
 
virtual const MFloatPointviewportRectangleOverride ()
 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 MStringArrayinputTargets ()
 An array of input target names that semantically declares the type of targets the operation requires as input. More...
 
const MStringArrayoutputTargets ()
 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

- Public Types inherited from MRenderOperation
enum  MRenderOperationType {
  kClear, kSceneRender, kQuadRender, kUserDefined,
  kHUDRender, kPresentTarget
}
 Supported render operation types. More...
 
- Protected Member Functions inherited from MRenderOperation
 MRenderOperation (const MString &name)
 Protected constructor. More...
 
MRenderTargetgetInputTarget (const MString &name)
 Gets the target associated with this input. More...
 
- Protected Attributes inherited from MRenderOperation
MRenderOperationType mOperationType
 Operation type.
 
MString mName
 Identifier for a sub render.
 

Member Function Documentation

const MString & name ( ) const
virtual

Name for a HUD render operation.

Note that all HUD operations share the same name since they need not be distinguished from one another.

Returns
Unique name for a hud render operation

Reimplemented from MRenderOperation.

bool hasUIDrawables ( ) const
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.

Returns
Whether addUIDrawables() will be called or not.
+ Examples:
void addUIDrawables ( MUIDrawManager drawManager2D,
const MFrameContext frameContext 
)
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.

Parameters
[in]drawManager2DA 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]frameContextFrame level context information.
+ Examples:

The documentation for this class was generated from the following files:
  • MViewport2Renderer.h
  • MViewport2Renderer.cpp