AVxcelerate Sensors Simulator API 2025 R1

vss::simulation::RenderingParameters Struct Reference

Last update: 14.01.2025

Sets the rendering engine parameters for a camera. More...

Collaboration diagram for vss::simulation::RenderingParameters:
Collaboration graph
[legend]

Classes

struct  RealTimeParameters
 Sets the camera simulation parameters for real time rendering. More...
 

Public Attributes

google::protobuf::FloatValue camera_near_plane = 1 [deprecated = true]
 
google::protobuf::FloatValue camera_far_plane = 2 [deprecated = true]
 
Qualities shadow_quality = 3 [deprecated = true]
 
Qualities texture_quality = 4 [deprecated = true]
 
google::protobuf::BoolValue borderless = 5
 
google::protobuf::FloatValue antialiasing_factor = 6 [deprecated = true]
 
google::protobuf::BoolValue vertical_sync = 7
 
google::protobuf::BoolValue enable_alpha_channel = 9
 
bool enable_asynchronous_readback = 10
 
RealTimeParameters real_time_parameters = 8
 

Detailed Description

Sets the rendering engine parameters for a camera.

Member Data Documentation

◆ camera_near_plane

google::protobuf::FloatValue vss::simulation::RenderingParameters::camera_near_plane = 1 [deprecated = true]

The camera near plane value.

Unit: meters (m)

Range: ] 0, camera_far_plane [

Default value: 0.1

Warning
This field is marked deprecated and might be removed in later versions. Consider using RealTimeParameters.camera_near_plane instead.

◆ camera_far_plane

google::protobuf::FloatValue vss::simulation::RenderingParameters::camera_far_plane = 2 [deprecated = true]

The camera far plane.

Unit: meters (m)

Range: ] CameraNearPlane, float max ]

Default value: 10000.0

Warning
This field is marked deprecated and might be removed in later versions. Consider using RealTimeParameters.camera_far_plane instead.

◆ shadow_quality

Qualities vss::simulation::RenderingParameters::shadow_quality = 3 [deprecated = true]

The camera shadow quality.

Default value: EXTREME

Warning
This field is marked deprecated and might be removed in later versions. Consider using RealTimeParameters.shadow_quality instead.

◆ texture_quality

Qualities vss::simulation::RenderingParameters::texture_quality = 4 [deprecated = true]

The camera texture quality.

Default value: EXTREME

Warning
This field is marked deprecated and might be removed in later versions. Consider using RealTimeParameters.texture_quality instead.

◆ borderless

google::protobuf::BoolValue vss::simulation::RenderingParameters::borderless = 5

Indicates whether or not the rendering window is borderless.

Default value: false

◆ antialiasing_factor

google::protobuf::FloatValue vss::simulation::RenderingParameters::antialiasing_factor = 6 [deprecated = true]

The camera antialiasing factor.

Range: [ 1.0, 4.0 ]

Default value: 1.0

Warning
This field is marked deprecated and might be removed in later versions. Consider using RealTimeParameters.antialiasing_factor instead.

◆ vertical_sync

google::protobuf::BoolValue vss::simulation::RenderingParameters::vertical_sync = 7

Vertical synchronization between the rendering frequency of the Display and the frame rate of the screen where the rendering window is located.

Default value: false

◆ enable_alpha_channel

google::protobuf::BoolValue vss::simulation::RenderingParameters::enable_alpha_channel = 9

Enables or disables the alpha channel in the camera output.

Default value: true

Note
The values for the alpha channel are not used and are filled with default values.

◆ enable_asynchronous_readback

bool vss::simulation::RenderingParameters::enable_asynchronous_readback = 10

Enables or disables asynchronous GPU readback.

Default value: false

Note
Asynchronous GPU readback is delivered as a beta feature in the current release.

◆ real_time_parameters

RealTimeParameters vss::simulation::RenderingParameters::real_time_parameters = 8

ONEOF(specific_parameters) Camera simulation parameters for real time rendering.

The documentation for this struct was generated from the following file:
  • simulation_parameters.proto

Connect with Ansys