
Static Public Member Functions | |
static HPS.VisualEffectsKit | GetDefault () |
static bool | operator!= (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b) |
static bool | operator== (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.VisualEffectsKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.VisualEffectsKit.GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
◆ VisualEffectsKit() [1/2]
|
inline |
Initializes an empty kit.
◆ VisualEffectsKit() [2/2]
|
inline |
The copy constructor creates a new VisualEffectsKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source VisualEffectsKit is equivalent to this object.
- Parameters
-
in_kit The source VisualEffectsKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
Creates a VisualEffectsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A VisualEffectsKit with the default settings.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
◆ Set()
|
inline |
Copies the source VisualEffectsKit into this object.
- Parameters
-
in_kit The source object to copy.
◆ SetAmbientOcclusionEnabled()
|
inline |
Allows ambient occlusion to be enabled or disabled on a per segment basis.
- Parameters
-
in_state Whether ambient occlusion should be used.
- Returns
- A reference to this object.
◆ SetAntiAliasing()
|
inline |
Manipulates the state of anti-aliasing(text and screen).
- Deprecated:
- This function exists for compatibility and SetTextAntiAliasing(bool in_state) should be preferred in general usage.
- Parameters
-
in_state Whether anti-aliasing(text and screen) should be used.
- Returns
- A reference to this object.
◆ SetBloomEnabled()
|
inline |
Allows bloom to be enabled or disabled on a per segment basis.
- Parameters
-
in_state Whether bloom should be used.
- Returns
- A reference to this object.
◆ SetDepthOfFieldEnabled()
|
inline |
Allows depth of field to be enabled or disabled on a per segment basis.
- Parameters
-
in_state Whether depth of field should be used.
- Returns
- A reference to this object.
◆ SetEyeDomeLightingBackColor() [1/3]
|
inline |
Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting.
- Parameters
-
in_state Whether a back color should be used for eye dome lighting. in_color The color to use for the back of a point for eye dome lighting.
- Returns
- A reference to this object.
◆ SetEyeDomeLightingBackColor() [2/3]
|
inline |
Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting.
- Parameters
-
in_state Whether a back color should be used for eye dome lighting.
- Returns
- A reference to this object.
◆ SetEyeDomeLightingBackColor() [3/3]
|
inline |
Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting. The state is implicitly on.
- Parameters
-
in_color The color to use for the back of a point for eye dome lighting.
- Returns
- A reference to this object.
◆ SetEyeDomeLightingEnabled()
|
inline |
Allows eye dome lighting to be enabled or disabled on a per segment basis.
- Parameters
-
in_state Whether eye dome lighting should be used.
- Returns
- A reference to this object.
◆ SetPostProcessEffectsEnabled()
|
inline |
Allows all post-processing effects to be enabled or disabled en masse on a per segment basis.
- Parameters
-
in_state Whether post-processing effects should be used.
- Returns
- A reference to this object.
◆ SetShadowMaps() [1/6]
|
inline |
Manipulates the state of shadow maps in the scene.
- Parameters
-
in_state Whether shadow maps should be used. in_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. in_resolution The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. in_view_dependent When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene. in_jitter Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map.
- Returns
- A reference to this object.
◆ SetShadowMaps() [2/6]
|
inline |
Manipulates the state of shadow maps in the scene.
- Parameters
-
in_state Whether shadow maps should be used. in_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. in_resolution The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. in_view_dependent When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene.
- Returns
- A reference to this object.
◆ SetShadowMaps() [3/6]
|
inline |
Manipulates the state of shadow maps in the scene.
- Parameters
-
in_state Whether shadow maps should be used. in_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. in_resolution The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048.
- Returns
- A reference to this object.
◆ SetShadowMaps() [4/6]
|
inline |
Manipulates the state of shadow maps in the scene.
- Parameters
-
in_state Whether shadow maps should be used. in_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
- Returns
- A reference to this object.
◆ SetShadowMaps() [5/6]
|
inline |
Manipulates the state of shadow maps in the scene.
- Parameters
-
in_state Whether shadow maps should be used.
- Returns
- A reference to this object.
◆ SetShadowMaps() [6/6]
|
inline |
Manipulates the state of shadow maps in the scene. The state is implicitly on.
- Parameters
-
in_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. in_resolution The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. in_view_dependent When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene. in_jitter Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map.
- Returns
- A reference to this object.
◆ SetSilhouetteEdgesEnabled()
|
inline |
Allows silhouette edges to be enabled or disabled on a per segment basis.
- Parameters
-
in_state Whether silhouette edges should be used.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [1/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_fading Whether the reflection plane should fade as it moves away from the camera. in_attenuation_near_distance The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance. in_attenuation_far_distance The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [2/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_fading Whether the reflection plane should fade as it moves away from the camera. in_attenuation_near_distance The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [3/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_fading Whether the reflection plane should fade as it moves away from the camera.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [4/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
- Returns
- A reference to this object.
◆ SetSimpleReflection() [5/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [6/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used.
- Returns
- A reference to this object.
◆ SetSimpleReflection() [7/7]
|
inline |
Manipulates the state of simple reflections, projected onto a plane. The state is implicitly on.
- Parameters
-
in_opacity An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_fading Whether the reflection plane should fade as it moves away from the camera. in_attenuation_near_distance The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance. in_attenuation_far_distance The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.
- Returns
- A reference to this object.
◆ SetSimpleReflectionPlane() [1/2]
|
inline |
Manipulates the location and orientation of the plane that simple reflections are projected onto.
- Parameters
-
in_projected_onto The plane that simple reflections should be projected onto.
- Returns
- A reference to this object.
◆ SetSimpleReflectionPlane() [2/2]
|
inline |
Manipulates the location and orientation of the plane that simple reflections are projected onto.
- Returns
- A reference to this object.
◆ SetSimpleReflectionVisibility()
|
inline |
Defines the visibility settings for the model when rendered in the reflection plane.
- Parameters
-
in_reflected_types A collection of visibility settings that will be applied to the reflected geometry.
- Returns
- A reference to this object.
◆ SetSimpleShadow() [1/5]
|
inline |
Manipulates the state of simple shadows, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_resolution The width and height of the simple shadow. Valid range is [32, 1024]. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_ignore_transparency Whether any segment-level transparency setting should be ignored when rendering the simple shadow.
- Returns
- A reference to this object.
◆ SetSimpleShadow() [2/5]
|
inline |
Manipulates the state of simple shadows, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_resolution The width and height of the simple shadow. Valid range is [32, 1024]. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
- Returns
- A reference to this object.
◆ SetSimpleShadow() [3/5]
|
inline |
Manipulates the state of simple shadows, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used. in_resolution The width and height of the simple shadow. Valid range is [32, 1024].
- Returns
- A reference to this object.
◆ SetSimpleShadow() [4/5]
|
inline |
Manipulates the state of simple shadows, projected onto a plane.
- Parameters
-
in_state Whether simple shadows should be used.
- Returns
- A reference to this object.
◆ SetSimpleShadow() [5/5]
|
inline |
Manipulates the state of simple shadows, projected onto a plane. The state is implicitly on.
- Parameters
-
in_resolution The width and height of the simple shadow. Valid range is [32, 1024]. in_blurring The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. in_ignore_transparency Whether any segment-level transparency setting should be ignored when rendering the simple shadow.
- Returns
- A reference to this object.
◆ SetSimpleShadowColor() [1/2]
|
inline |
Sets the color that simple shadows will be rendered in.
- Parameters
-
in_color The color of simple shadows.
- Returns
- A reference to this object.
◆ SetSimpleShadowColor() [2/2]
|
inline |
Sets the color that simple shadows will be rendered in.
- Returns
- A reference to this object.
◆ SetSimpleShadowLightDirection() [1/2]
|
inline |
Sets the direction that the light source for a simple shadow is coming from.
- Parameters
-
in_direction The direction that the light source for a simple shadow is coming from.
- Returns
- A reference to this object.
◆ SetSimpleShadowLightDirection() [2/2]
|
inline |
Sets the direction that the light source for a simple shadow is coming from.
- Returns
- A reference to this object.
◆ SetSimpleShadowPlane() [1/2]
|
inline |
Manipulates the location and orientation of the plane that simple shadows are projected onto.
- Parameters
-
in_projected_onto The plane that simple shadows should be projected onto.
- Returns
- A reference to this object.
◆ SetSimpleShadowPlane() [2/2]
|
inline |
Manipulates the location and orientation of the plane that simple shadows are projected onto.
- Returns
- A reference to this object.
◆ SetTextAntiAliasing()
|
inline |
Manipulates the state of anti-aliasing.
- Parameters
-
in_state Whether anti-aliasing should be used.
- Returns
- A reference to this object.
◆ Show()
|
inline |
Copies this object into the given VisualEffectsKit.
- Parameters
-
out_kit The VisualEffectsKit to populate with the contents of this object.
◆ ShowAmbientOcclusionEnabled()
|
inline |
Shows the ambient occlusion setting.
- Parameters
-
out_state Whether ambient occlusion is enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowAntiAliasing()
|
inline |
Shows the anti-aliasing setting.
- Deprecated:
- This function exists for compatibility and ShowTextAntiAliasing(bool & out_state) should be preferred in general usage.
- Parameters
-
out_state Whether anti-aliasing(text and screen) should be used.
- Returns
- true if the setting(text and screen) is valid, false otherwise.
◆ ShowBloomEnabled()
|
inline |
Shows the bloom setting.
- Parameters
-
out_state Whether bloom is enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowDepthOfFieldEnabled()
|
inline |
Shows the depth of field setting.
- Parameters
-
out_state Whether depth of field is enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowEyeDomeLightingBackColor()
|
inline |
Shows the eye dome lighting back color setting.
- Parameters
-
out_state Whether a back color should be used for eye dome lighting. out_color The color to use for the back of a point for eye dome lighting.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowEyeDomeLightingEnabled()
|
inline |
Shows the eye dome lighting setting.
- Parameters
-
out_state Whether eye dome lighting is enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowPostProcessEffectsEnabled()
|
inline |
Shows the post-processing effects setting.
- Parameters
-
out_state Whether post-processing effects are enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowShadowMaps()
|
inline |
Shows the shadow maps setting.
- Parameters
-
out_state Whether shadow maps should be used. out_samples The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. out_resolution The width and height of the shadow map. out_view_dependent When enabled, the view frustum is taken into account when generating shadow maps. out_jitter Whether stochastic sampling of shadow maps should be use to reduce aliasing in the shadow map.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSilhouetteEdgesEnabled()
|
inline |
Shows the silhouette edges setting.
- Parameters
-
out_state Whether silhouette edges are enabled.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleReflection()
|
inline |
Shows the simple reflection setting.
- Parameters
-
out_state Whether simple shadows should be used. out_opacity An alpha value that sets the transparency level of the reflection plane. out_blurring The level of blurring (softening) that is applied to the shadow. out_fading Whether the reflection plane should fade as it moves away from the camera. out_attenuation_near_distance The orthogonal distances (in world space) from the reflection plane that the model begins to fade. out_attenuation_far_distance The orthogonal distances (in world space) from the reflection plane that the model is completely faded.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleReflectionPlane()
|
inline |
Shows the simple reflection plane setting.
- Parameters
-
out_projected_onto The plane that simple reflections should be projected onto.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleReflectionVisibility()
|
inline |
Shows the simple shadow visibility setting.
- Parameters
-
out_reflected_types A collection of visibility settings that will be applied to the reflected geometry.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleShadow()
|
inline |
Shows the simple shadow setting.
- Parameters
-
out_state Whether simple shadows should be used. out_resolution The width and height of the simple shadow. out_blurring The level of blurring (softening) that is applied to the shadow. out_ignore_transparency Whether any segment-level transparency setting should be ignored when rendering the simple shadow.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleShadowColor()
|
inline |
Shows the simple shadow color setting.
- Parameters
-
out_color The color of simple shadows.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleShadowLightDirection()
|
inline |
Shows the simple shadow light direction setting.
- Parameters
-
out_direction The direction that the light source for a simple shadow is coming from.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSimpleShadowPlane()
|
inline |
Shows the simple shadow plane setting.
- Parameters
-
out_projected_onto The plane that simple shadows should be projected onto.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowTextAntiAliasing()
|
inline |
Shows the text anti-aliasing setting.
- Parameters
-
out_state Whether text anti-aliasing should be used.
- Returns
- true if the setting is valid, false otherwise.
◆ UnsetAmbientOcclusionEnabled()
|
inline |
Removes any ambient occlusion setting.
- Returns
- A reference to this object.
◆ UnsetAntiAliasing()
|
inline |
Removes any anti-alias setting(text and screen).
- Deprecated:
- This function exists for compatibility and UnsetTextAntiAliasing() should be preferred in general usage.
- Returns
- A reference to this object.
◆ UnsetBloomEnabled()
|
inline |
Removes any bloom setting.
- Returns
- A reference to this object.
◆ UnsetDepthOfFieldEnabled()
|
inline |
Removes any depth of field setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetEyeDomeLightingBackColor()
|
inline |
Removes any eye dome lighting back color setting.
- Returns
- A reference to this object.
◆ UnsetEyeDomeLightingEnabled()
|
inline |
Removes any eye dome lighting setting.
- Returns
- A reference to this object.
◆ UnsetPostProcessEffectsEnabled()
|
inline |
Removes any post-processing effects setting.
- Returns
- A reference to this object.
◆ UnsetShadowMaps()
|
inline |
Removes any shadow maps setting.
- Returns
- A reference to this object.
◆ UnsetSilhouetteEdgesEnabled()
|
inline |
Removes any silhouette edges setting.
- Returns
- A reference to this object.
◆ UnsetSimpleReflection()
|
inline |
Removes any simple reflection setting.
- Returns
- A reference to this object.
◆ UnsetSimpleReflectionPlane()
|
inline |
Removes any simple reflection plane setting.
- Returns
- A reference to this object.
◆ UnsetSimpleReflectionVisibility()
|
inline |
Removes any simple reflection visibility setting.
- Returns
- A reference to this object.
◆ UnsetSimpleShadow()
|
inline |
Removes any simple shadow setting.
- Returns
- A reference to this object.
◆ UnsetSimpleShadowColor()
|
inline |
Removes any simple shadow color setting.
- Returns
- A reference to this object.
◆ UnsetSimpleShadowLightDirection()
|
inline |
Removes any simple shadow light direction setting.
- Returns
- A reference to this object.
◆ UnsetSimpleShadowPlane()
|
inline |
Removes any simple shadow plane setting.
- Returns
- A reference to this object.
◆ UnsetTextAntiAliasing()
|
inline |
Removes any text anti-alias setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.VisualEffectsKit.cs