 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
Options that are used for performing an update on a Graphics Engine call. More...
Public Member Functions | |
| GraphicsUpdateArguments () | |
| Default constructor. | |
| ~GraphicsUpdateArguments () | |
| Destructor. | |
| void | finishPipelineRecreation () |
| Marks pipeline recreation as complete. | |
| bool | isDrawing () const |
| Checks whether a draw operation is currently in progress. | |
| bool | needsBufferRecreation () const |
| Checks whether buffers need recreation. | |
| bool | needsPipelineRecreation () const |
| Checks whether the pipeline needs recreation. | |
| void | setBufferRecreation (bool needed) |
| Sets whether buffer recreation is needed. | |
| void | setPipelineRecreationNeeded () |
| Marks the pipeline as needing recreation. | |
Public Attributes | |
| RGBColor | background_color = RGBColor(255, 255, 255, 255) |
| Viewport background color. | |
| UUID | camera |
| UUID of the camera being rendered. | |
| fltp04 | depth_bias = 0.0f |
| Depth bias for polygon offset. | |
| GraphicsDevice * | device |
| The active graphics device. | |
| std::function< void()> | ensure_render_complete |
| Callback to ensure the previous render is complete. | |
| uint04 | frame_count = 0U |
| Total number of frames rendered. | |
| uint04 | frame_index = Constant<uint04>::Invalid |
| Index of the current frame in the swap chain. | |
| void * | frame_resource = nullptr |
| Opaque per-frame resource handle. | |
| Time | frame_time |
| Timestamp of the current frame. | |
| Image * | grab_image = nullptr |
| Target image for screen capture. | |
| ConstPointer< Set< UUID > > | hidden_items |
| Set of explicitly hidden item UUIDs. | |
| bool | is_grab_image |
| Whether an image grab is pending. | |
| LogPtr | log |
| The log. | |
| DesignObjectLookup * | lookup |
| The design object lookup. | |
| uint04 | multisample_count |
| Number of multisample samples. | |
| Dictionary< UUID, bool > | needs_screen_draw |
| Per-camera screen draw flags. | |
| Material | override_material |
| Material override applied to all objects. | |
| Time | refresh_command_time |
| Time of the last command refresh. | |
| Buffer< bool > | should_draw_cache |
| Cached draw flags for models. | |
| ConstPointer< Set< UUID > > | visible_items |
| Set of explicitly visible item UUIDs (null = show all). | |
| Vector< 2, uint04 > | window_size |
| Viewport width and height in pixels. | |
Protected Attributes | |
| bool | m_needs_buffer_recreation |
| Whether buffers need recreation. | |
| bool | m_needs_pipeline_recreation |
| Whether the pipeline needs recreation. | |
Options that are used for performing an update on a Graphics Engine call.
Definition at line 43 of file GraphicsUpdateArguments.h.
| bool GraphicsUpdateArguments::isDrawing | ( | ) | const |
Checks whether a draw operation is currently in progress.
|
inline |
Checks whether buffers need recreation.
Definition at line 63 of file GraphicsUpdateArguments.h.
References m_needs_buffer_recreation.
|
inline |
Checks whether the pipeline needs recreation.
Definition at line 60 of file GraphicsUpdateArguments.h.
References m_needs_pipeline_recreation.
| void GraphicsUpdateArguments::setBufferRecreation | ( | bool | needed | ) |
Sets whether buffer recreation is needed.
| [in] | needed | Whether recreation is needed. |
References needs_screen_draw.