## On this page

  

 

 # vss::simulation::RenderingParameters Struct Reference

 Last update: 14.01.2025 

Sets the rendering engine parameters for a camera. [More...](structvss_1_1simulation_1_1_rendering_parameters.xhtml#details)

Collaboration diagram for vss::simulation::RenderingParameters:

![Collaboration graph](/sites/default/files/migrate-content/avxcelerate_sensors_simulator_api_2025_r1/structvss_1_1simulation_1_1_rendering_parameters__coll__graph.png)

\[[legend](graph_legend.xhtml)\]

## <a name="nested-classes"></a>Classes

struct [RealTimeParameters](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml) Sets the camera simulation parameters for real time rendering. [More...](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#details)  
 ## <a name="pub-attribs"></a>Public Attributes

google::protobuf::FloatValue [camera\_near\_plane](structvss_1_1simulation_1_1_rendering_parameters.xhtml#ab1079b5e0ac8426c4f23a62cba776b2d) = 1 \[deprecated = true\] google::protobuf::FloatValue [camera\_far\_plane](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a8656ad82a8121af563da4df1d395c97c) = 2 \[deprecated = true\] [Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684) [shadow\_quality](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a8a6e06da7ce13460d212701c8f21d7ab) = 3 \[deprecated = true\] [Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684) [texture\_quality](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a1dcea248e7b738f9e72248414a7441fe) = 4 \[deprecated = true\] google::protobuf::BoolValue [borderless](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a2417bdf1f7d38eb12e8ca30f6f9fa81b) = 5 google::protobuf::FloatValue [antialiasing\_factor](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a605b9f16152b40e3b2f96bbd4fe7245d) = 6 \[deprecated = true\] google::protobuf::BoolValue [vertical\_sync](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a538847812285ed697366fe55fc87fc54) = 7 google::protobuf::BoolValue [enable\_alpha\_channel](structvss_1_1simulation_1_1_rendering_parameters.xhtml#abdf78d46e29058ebf631ae16756ddd65) = 9 bool [enable\_asynchronous\_readback](structvss_1_1simulation_1_1_rendering_parameters.xhtml#ae141dfc7416640a294095e6bc9f0936e) = 10 [RealTimeParameters](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml) [real\_time\_parameters](structvss_1_1simulation_1_1_rendering_parameters.xhtml#a23ac17870fccac097d3778e9d6c39ca0) = 8 <a id="details" name="details"></a>## Detailed Description

Sets the rendering engine parameters for a camera.



## Member Data Documentation

<a id="ab1079b5e0ac8426c4f23a62cba776b2d"></a>## [◆ ](#ab1079b5e0ac8426c4f23a62cba776b2d)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

WarningThis field is marked deprecated and might be removed in later versions. Consider using [RealTimeParameters.camera\_near\_plane](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#a7c98a01e825f8aa05938975bd5618ffe) instead. 



<a id="a8656ad82a8121af563da4df1d395c97c"></a>## [◆ ](#a8656ad82a8121af563da4df1d395c97c)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

WarningThis field is marked deprecated and might be removed in later versions. Consider using [RealTimeParameters.camera\_far\_plane](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#a3aef4baee872dd0a8c98e625fde169f3) instead. 



<a id="a8a6e06da7ce13460d212701c8f21d7ab"></a>## [◆ ](#a8a6e06da7ce13460d212701c8f21d7ab)shadow\_quality

 [Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684) vss::simulation::RenderingParameters::shadow\_quality = 3 \[deprecated = true\]

The camera shadow quality.

Default value: EXTREME

WarningThis field is marked deprecated and might be removed in later versions. Consider using [RealTimeParameters.shadow\_quality](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#ab65534ee12eef2af72263b2e5d27cd3a) instead. 



<a id="a1dcea248e7b738f9e72248414a7441fe"></a>## [◆ ](#a1dcea248e7b738f9e72248414a7441fe)texture\_quality

 [Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684) vss::simulation::RenderingParameters::texture\_quality = 4 \[deprecated = true\]

The camera texture quality.

Default value: EXTREME

WarningThis field is marked deprecated and might be removed in later versions. Consider using [RealTimeParameters.texture\_quality](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#a2eafeed1d033b7c9ae74df42769908c5) instead. 



<a id="a2417bdf1f7d38eb12e8ca30f6f9fa81b"></a>## [◆ ](#a2417bdf1f7d38eb12e8ca30f6f9fa81b)borderless

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

Indicates whether or not the rendering window is borderless.

Default value: false





<a id="a605b9f16152b40e3b2f96bbd4fe7245d"></a>## [◆ ](#a605b9f16152b40e3b2f96bbd4fe7245d)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

WarningThis field is marked deprecated and might be removed in later versions. Consider using [RealTimeParameters.antialiasing\_factor](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml#aab26495174f7c707086b4e3fb9598117) instead. 



<a id="a538847812285ed697366fe55fc87fc54"></a>## [◆ ](#a538847812285ed697366fe55fc87fc54)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





<a id="abdf78d46e29058ebf631ae16756ddd65"></a>## [◆ ](#abdf78d46e29058ebf631ae16756ddd65)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

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



<a id="ae141dfc7416640a294095e6bc9f0936e"></a>## [◆ ](#ae141dfc7416640a294095e6bc9f0936e)enable\_asynchronous\_readback

 bool vss::simulation::RenderingParameters::enable\_asynchronous\_readback = 10

Enables or disables asynchronous GPU readback.

Default value: false

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



<a id="a23ac17870fccac097d3778e9d6c39ca0"></a>## [◆ ](#a23ac17870fccac097d3778e9d6c39ca0)real\_time\_parameters

 [RealTimeParameters](structvss_1_1simulation_1_1_rendering_parameters_1_1_real_time_parameters.xhtml) 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