Skip to content

Vp ​

Namespaces ​

Name
Vp::GfxUtils

Classes ​

Name
classVp::AbstractCamera <br>Abstract camera base class.
classVp::AbstractOrbitCamera <br>Abstract camera that turns around a point (pivot) at a certain distance (radius).
classVp::AggregateCamera <br>Camera with multiple modes that it can seamlessly switch between.
classVp::BoxBlurShader <br>Two pass box blur with alpha support.
structVp::CameraSettings
classVp::ColorAttachment <br>Color attachment using a 2D Texture.
classVp::ColoredObject
classVp::ColorShader <br>Basic shader to display unlit colored primitives.
classVp::DepthAttachment <br>Depth attachment using a Renderbuffer.
classVp::DisplayOptions <br>Options specifying various display settings for rendering a scene.
classVp::Entity <br>A scene entity base class.
classVp::Framebuffer <br>A utility class for managing an OpenGL FrameBufferObject.
classVp::FrustumObject
classVp::FrustumShader <br>Shader for displaying projection frustums.
classVp::GameObject <br>Regular world object entity.
structVp::GlobalCameraSettings
classVp::GridObject
structVp::GridSettings
classVp::GridShader <br>Shader for the infinite grid of the standard basis.
classVp::GridShaderGeneric <br>Shader for a generic infinite grid representing an affine space with any basis.
structVp::HighlightSettings
classVp::Light
classVp::Lighting <br>Class that manages passing of light information to shaders.
classVp::MainScene
classVp::Manipulators
classVp::ObjectShader
classVp::OrbitCamera <br>Camera turning around a point using an azimuth and elevation angle.
classVp::PhongShader <br>Shader for lit objects with textures.
classVp::PointLight
classVp::PreviewScene
classVp::RenderOptions <br>Options specifying how a scene should be rendered.
classVp::Scene <br>A scene representing a "game world" that contains entities and is viewed by a camera.
classVp::SceneCamera <br>Viewport entity representing a Camera node in Core/GUI.
classVp::SceneModel <br>Viewport entity representing a Model node in Core/GUI.
classVp::SceneRenderTarget <br>A set of framebuffers and their settings into which a Scene can draw.
classVp::SceneScreen <br>Viewport entity representing a screen node.
classVp::SceneSelectable
classVp::ScreenOverlayShader
classVp::SelectionCompositeShader
classVp::SelectStencil
classVp::Shader <br>Base class for shaders.
classVp::Shaders
classVp::Shaper <br>A utility class for constructing simple shapes.
classVp::SpotLight
classVp::SunLight
classVp::TexturedObject
classVp::Trackball <br>Static utility class for trackball interaction.
classVp::TrackballCamera <br>Camera turning around a point using a virtual screen-space trackball.
classVp::Viewport <br>Scene viewport class.
structVp::ViewportGlobalSettings <br>Global viewport settings, some used only for initialisation, some used during runtime.
structVp::ViewportSettings <br>A collection of viewport settings.
classVp::WBOITCompositeShader
classVp::WorldShader <br>Abstract shader that provides PVM matrices uniforms.

Types ​

Name
enum classDisplayType { Default, Axes, Grid, Camera, Frustum, Tracking}

Functions ​

Name
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_sizeproperty("camera" , &ViewportGlobalSettings::camera )
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_size &ViewportGlobalSettings::highlightproperty("grid" , &ViewportGlobalSettings::grid )
&GridSettings::size &GridSettings::grid1FadeStartproperty("grid1FadeEnd" , &GridSettings::grid1FadeEnd )
&GridSettings::size &GridSettings::grid1FadeStart &GridSettings::grid2FadeStartproperty("grid2FadeEnd" , &GridSettings::grid2FadeEnd )
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactor &HighlightSettings::selectionColorproperty("highlightColor" , &HighlightSettings::highlightColor )
&HighlightSettings::downscaleFactorproperty("kernelSize" , &HighlightSettings::kernelSize )
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeedproperty("lighting_lightingModel" , &ViewportGlobalSettings::lighting_lightingModel )
&GridSettings::sizeproperty("lineWidth" , &GridSettings::lineWidth )
&ViewportGlobalSettings::preview_fovproperty("preview_radiusFactor" , &ViewportGlobalSettings::preview_radiusFactor )
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoffproperty("useDepth" , &HighlightSettings::useDepth )
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactorproperty("useDepth_desaturateFactor" , &HighlightSettings::useDepth_desaturateFactor )

Attributes ​

Name
RTTR_REGISTRATION

Types Documentation ​

enum DisplayType ​

EnumeratorValueDescription
Default
Axes
Grid
Camera
Frustum
Tracking

Functions Documentation ​

function property ​

cpp
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_size property(
    "camera" ,
    &ViewportGlobalSettings::camera 
)
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_size property(
    "camera" ,
    &ViewportGlobalSettings::camera 
)

function property ​

cpp
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_size &ViewportGlobalSettings::highlight property(
    "grid" ,
    &ViewportGlobalSettings::grid 
)
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed &ViewportGlobalSettings::manipulator_size &ViewportGlobalSettings::highlight property(
    "grid" ,
    &ViewportGlobalSettings::grid 
)

function property ​

cpp
&GridSettings::size &GridSettings::grid1FadeStart property(
    "grid1FadeEnd" ,
    &GridSettings::grid1FadeEnd 
)
&GridSettings::size &GridSettings::grid1FadeStart property(
    "grid1FadeEnd" ,
    &GridSettings::grid1FadeEnd 
)

function property ​

cpp
&GridSettings::size &GridSettings::grid1FadeStart &GridSettings::grid2FadeStart property(
    "grid2FadeEnd" ,
    &GridSettings::grid2FadeEnd 
)
&GridSettings::size &GridSettings::grid1FadeStart &GridSettings::grid2FadeStart property(
    "grid2FadeEnd" ,
    &GridSettings::grid2FadeEnd 
)

function property ​

cpp
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactor &HighlightSettings::selectionColor property(
    "highlightColor" ,
    &HighlightSettings::highlightColor 
)
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactor &HighlightSettings::selectionColor property(
    "highlightColor" ,
    &HighlightSettings::highlightColor 
)

function property ​

cpp
&HighlightSettings::downscaleFactor property(
    "kernelSize" ,
    &HighlightSettings::kernelSize 
)
&HighlightSettings::downscaleFactor property(
    "kernelSize" ,
    &HighlightSettings::kernelSize 
)

function property ​

cpp
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed property(
    "lighting_lightingModel" ,
    &ViewportGlobalSettings::lighting_lightingModel 
)
&ViewportGlobalSettings::preview_fov &ViewportGlobalSettings::preview_rotateSpeed property(
    "lighting_lightingModel" ,
    &ViewportGlobalSettings::lighting_lightingModel 
)

function property ​

cpp
&GridSettings::size property(
    "lineWidth" ,
    &GridSettings::lineWidth 
)
&GridSettings::size property(
    "lineWidth" ,
    &GridSettings::lineWidth 
)

function property ​

cpp
&ViewportGlobalSettings::preview_fov property(
    "preview_radiusFactor" ,
    &ViewportGlobalSettings::preview_radiusFactor 
)
&ViewportGlobalSettings::preview_fov property(
    "preview_radiusFactor" ,
    &ViewportGlobalSettings::preview_radiusFactor 
)

function property ​

cpp
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff property(
    "useDepth" ,
    &HighlightSettings::useDepth 
)
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff property(
    "useDepth" ,
    &HighlightSettings::useDepth 
)

function property ​

cpp
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactor property(
    "useDepth_desaturateFactor" ,
    &HighlightSettings::useDepth_desaturateFactor 
)
&HighlightSettings::downscaleFactor &HighlightSettings::outlineCutoff &HighlightSettings::useDepth_darkenFactor property(
    "useDepth_desaturateFactor" ,
    &HighlightSettings::useDepth_desaturateFactor 
)

Attributes Documentation ​

variable RTTR_REGISTRATION ​

cpp
RTTR_REGISTRATION {
	rttr::registration::class_<GlobalCameraSettings>("GlobalCameraSettings")
	    .property("smoothScroll", &GlobalCameraSettings::smoothScroll)
	    .property("smoothScrollDamping", &GlobalCameraSettings::smoothScrollDamping)
	    .property("orbitCamera_zoomSpeed", &GlobalCameraSettings::orbit_zoomSpeed)
	    .property("orbitCamera_rotateSpeed", &GlobalCameraSettings::orbit_rotateSpeed)
	    .property("orbitCamera_translateSpeed", &GlobalCameraSettings::orbit_translateSpeed)
	    .property("trackballCamera_zoomSpeed", &GlobalCameraSettings::trackball_zoomSpeed)
	    .property("trackballCamera_rotateSpeed", &GlobalCameraSettings::trackball_rotateSpeed)
	    .property("trackballCamera_translateSpeed", &GlobalCameraSettings::trackball_translateSpeed);
RTTR_REGISTRATION {
	rttr::registration::class_<GlobalCameraSettings>("GlobalCameraSettings")
	    .property("smoothScroll", &GlobalCameraSettings::smoothScroll)
	    .property("smoothScrollDamping", &GlobalCameraSettings::smoothScrollDamping)
	    .property("orbitCamera_zoomSpeed", &GlobalCameraSettings::orbit_zoomSpeed)
	    .property("orbitCamera_rotateSpeed", &GlobalCameraSettings::orbit_rotateSpeed)
	    .property("orbitCamera_translateSpeed", &GlobalCameraSettings::orbit_translateSpeed)
	    .property("trackballCamera_zoomSpeed", &GlobalCameraSettings::trackball_zoomSpeed)
	    .property("trackballCamera_rotateSpeed", &GlobalCameraSettings::trackball_rotateSpeed)
	    .property("trackballCamera_translateSpeed", &GlobalCameraSettings::trackball_translateSpeed);

Updated on 2025-05-31 at 12:55:31 +0000