NyxCameraOptions#

class gs_nyx_plugin.nyx_camera_options.NyxCameraOptions(*args, **kwargs)[source]#

Bases: NyxCameraSensor

Options for the Nyx Camera Sensor plugin.

Inherits from BaseCameraOptions which provides: - res, pos, lookat, up, fov, lights, offset_T (from BaseCameraOptions) - entity_idx, link_idx_local, pos_offset, euler_offset (from RigidSensorOptionsMixin)

Nyx-specific parameters are defined below.

Parameters:
  • model (Literal) – Camera model: “pinhole”. Default is “pinhole”.

  • spp (PositiveInt) – Samples per pixel for path tracing. Default is 16.

  • denoise (bool) – Whether to apply denoising. Default is True.

  • near (PositiveFloat) – Near clipping plane distance. Default is 0.1.

  • far (PositiveFloat) – Far clipping plane distance. Default is 100.0.

  • render_mode (ERenderMode) – Rendering mode for Nyx. Default is FastPathTracer.

  • debug_view (EDebugView) – Debug view mode for Nyx. Default is Meshlet.

  • tone_mapper (EToneMapper) – Tone mapper to apply post-render. Default is Reinhard.

  • anti_aliasing (EAntiAliasing) – Anti-aliasing technique. Default is SMAA.

  • open_window (bool) – Whether to open a GUI window. Default is False.

  • window_size (PositiveVec2IType) – Window size if open_window is enabled. Default is (1024, 1024).

  • args (Any)

  • kwargs (Any)

Return type:

Any

Methods

Attributes

anti_aliasing

Subpixel Morphological Anti-Aliasing.

debug_view

Per-meshlet color.

denoise

env_maps

far

light_fields

model

model_config

near

open_window

render_mode

Real-time biased path tracer.

spp

tone_mapper

Reinhard tone mapping operator.

update_ground_truth_only

window_size