 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
Stores the options, added to the user settings, that control Viewport and camera options in the application. More...
Public Types | |
| enum | ViewportBackgroundMode { e_1_color , e_2_color , e_4_color , e_skybox } |
| Defines the background rendering mode for a viewport. More... | |
Static Public Member Functions | |
| static void | ResetOptionsToDefaults () |
| Resets all ViewportOptions to their factory default values. | |
Static Public Attributes | |
| static ApplicationOption< RGBColor > | camera_background |
| The default camera background color for virtual views (applies for background mode 1 and 2 colors). | |
| static ApplicationOption< bool > | debug_graphics |
| Whether to enable graphics debugging output and validation layers. | |
| static ApplicationOption< Bounds< 1, fltp08 > > | default_far_plane_bounds |
| The allowed bounds for the far clipping plane distance. | |
| static ApplicationOption< uint04 > | default_multisample |
| The default number of multisample passes used to smooth edges of 3D renders. | |
| static ApplicationOption< bool > | default_multithreaded_render |
| Whether or not to execute rendering operations on a thread other than the main thread. | |
| static ApplicationOption< Bounds< 1, fltp08 > > | default_near_plane_bounds |
| The allowed bounds for the near clipping plane distance. | |
| static ApplicationOption< fltp08 > | default_orthographic_view_height |
| The default view height for orthographic cameras, in world units. | |
| static ApplicationOption< fltp08 > | default_orthographic_view_width |
| The default view width for orthographic cameras, in world units. | |
| static ApplicationOption< Angle< fltp08 > > | default_perspective_view_height |
| The default vertical field-of-view angle for perspective cameras. | |
| static ApplicationOption< Angle< fltp08 > > | default_perspective_view_width |
| The default horizontal field-of-view angle for perspective cameras. | |
| static ApplicationOption< UUID > | default_render_engine |
| The UUID of the default rendering engine to use. | |
| static ApplicationOption< fltp08 > | default_render_engine_fps |
| The default speed at which to draw 3D scenes. | |
| static ApplicationOption< bool > | default_show_heading_ruler_physical |
| Whether or not to show heading marks on a physical camera view by default, when possible. | |
| static ApplicationOption< bool > | default_show_heading_ruler_virtual |
| Whether or not to show heading marks on a virtual viewport (perspective mode) by default. | |
| static ApplicationOption< bool > | default_show_inclination_ruler_physical |
| Whether or not to show inclination marks on a physical camera view by default. | |
| static ApplicationOption< bool > | default_show_inclination_ruler_virtual |
| Whether or not to show inclination marks on a virtual viewport (perspective mode) by default. | |
| static ApplicationOption< bool > | default_show_x_spacing_ruler_virtual |
| Whether or not to show horizontal spacing marks on a virtual viewport (orthographic mode) by default. | |
| static ApplicationOption< bool > | default_show_y_spacing_ruler_virtual |
| Whether or not to show vertical spacing marks on a virtual viewport (orthographic mode) by default. | |
| static ApplicationOption< uint04 > | default_viewport_fps |
| The frames per second of a viewport. Increasing this will improve smoothness but raise rendering load. | |
| static ApplicationOption< TimeSpan > | focus_viewport_animation_time |
| Duration of the animation when focusing the viewport on an object. | |
| static TranslatedString | options_label |
| The category label in user settings under which all viewport options appear. | |
| static ApplicationOption< fltp04 > | pixel_thickness |
| The default scale to be applied to lines and text in virtual space. | |
| static ApplicationOption< fltp04 > | scale_to_camera_reference_distance |
| Scale factor relative to camera reference distance. Purpose unclear – may control line/text scaling relative to camera distance. | |
| static ApplicationOption< bool > | use_vulkan_fallback |
| Whether to use a Vulkan fallback renderer when the primary renderer is unavailable. | |
| static ApplicationOption< ViewportLayoutTheme > | viewport_layout_theme |
| The layout theme controlling how multiple viewports are arranged. | |
Stores the options, added to the user settings, that control Viewport and camera options in the application.
All options retained across application restart
Author: Tyler Parke
Date: 2023-01-16
Definition at line 17 of file ViewportOptions.h.
Defines the background rendering mode for a viewport.
| Enumerator | |
|---|---|
| e_1_color | Single solid background color. |
| e_2_color | Two-color vertical gradient background. |
| e_4_color | Four-color gradient background (one per corner). |
| e_skybox | Skybox cubemap background. |
Definition at line 22 of file ViewportOptions.h.