NvUIDrawState Class Reference
A class that manages all draw-related state. More...
#include <NvUI.h>
Public Member Functions | |
| NvUIDrawState (NvUST inTime, int32_t inWidth, int32_t inHeight, int32_t inDesignWidth=0, int32_t inDesignHeight=0) | |
| Default constructor. | |
Public Attributes | |
| NvUST | time |
| A UST timestamp for the "time" of a given Draw call. | |
| int32_t | width |
| The render-buffer view width. | |
| int32_t | height |
| The render-buffer view height. | |
| int32_t | designWidth |
| [optional] The current UI's designed width. | |
| int32_t | designHeight |
| [optional] The current UI's designed height. | |
| float | alpha |
| [optional] An alpha-fade override for this draw call, to help fading elements over time. | |
| float | rotation |
| [optional] A rotation (in degrees) to use for 'aligning' content between the design and the render-buffer. | |
Detailed Description
A class that manages all draw-related state.When calling a UI element to Draw itself, an NvUIDrawState object is passed in to give 'annotation' to the drawing process. This allows us to also add further information to the DrawState, without changing the signature of the Draw method.
Constructor & Destructor Documentation
| NvUIDrawState::NvUIDrawState | ( | NvUST | inTime, | |
| int32_t | inWidth, | |||
| int32_t | inHeight, | |||
| int32_t | inDesignWidth = 0, |
|||
| int32_t | inDesignHeight = 0 | |||
| ) | [inline] |
Default constructor.
Design sizes are optional params, all other members must be set after.
Member Data Documentation
| float NvUIDrawState::alpha |
[optional] An alpha-fade override for this draw call, to help fading elements over time.
Defaults to 1.0 (opaque).
| int32_t NvUIDrawState::designHeight |
[optional] The current UI's designed height.
Important for auto-scaling and orientation of UI widgets if there is an explicit 'design space' vs current viewport space.
| int32_t NvUIDrawState::designWidth |
[optional] The current UI's designed width.
Important for auto-scaling and orientation of UI widgets if there is an explicit 'design space' vs current viewport space.
| int32_t NvUIDrawState::height |
The render-buffer view height.
| float NvUIDrawState::rotation |
[optional] A rotation (in degrees) to use for 'aligning' content between the design and the render-buffer.
Defaults to 0.0 (unrotated).
A UST timestamp for the "time" of a given Draw call.
Currently unused.
| int32_t NvUIDrawState::width |
The render-buffer view width.
The documentation for this class was generated from the following file: