Skip to main content

Ctrl+K

Nyx for Genesis

User guide
API reference

Genesis

User guide
API reference

Genesis

Section Navigation

gs_nyx
- nyx_py_renderer
- nyx_py_sdk
  - export_scene_file
  - float3_y_up_a_to_z_up
  - float3_z_up_to_y_up_a
  - generate_uuid
  - import_scene_file
  - quaternion_conjugate
  - quaternion_mul
  - quaternion_wxyz_to_xyzw
  - quaternion_xyzw_to_wxyz
  - quaternion_y_up_a_to_z_up
  - quaternion_z_up_to_y_up_a
  - shutdown
  - startup
  - AnimationAsset
    
    Constructor
    
    frame_resize
    
    frame_size
    
    get_frame
    
    set_frame
    
    frameArray
    
    targetUUID
    
    type
    
    uuid
  - CameraAsset
    
    Constructor
    
    antiAliasing
    
    aperture
    
    denoise
    
    farPlane
    
    focalLength
    
    fovY
    
    lutURI
    
    nearPlane
    
    position
    
    resolution
    
    rotation
    
    spp
    
    toneMapper
    
    uuid
  - EAnimationType
    
    Transform
  - EAntiAliasing
    
    Off
    
    FXAA
    
    SMAA
  - EAreaShape
    
    Rectangle
    
    Sphere
    
    Tube
    
    Disc
  - EEnvMapLayout
    
    LongLat
    
    Column
    
    Row
    
    HorizontalCross
    
    VerticalCross
  - EInstanceType
    
    Primitive
    
    DynamicMesh
    
    Mesh
    
    SubScene
  - ELightFieldType
    
    SparseGrid
    
    GaussianField
  - ELightType
    
    Directional
    
    Point
    
    Spot
    
    Area
  - ELightUnit
    
    Lux
    
    Lumen
    
    Candela
    
    Nit
    
    EV100
  - EMaterialClipping
    
    Off
    
    On
  - EMaterialFeatures
    
    Standard
    
    Anisotropy
  - EMaterialOpacity
    
    Opaque
    
    Transparent
  - EMaterialProperty
    
    Off
    
    Opacity
    
    Clipping
    
    Sidedness
    
    NormalMode
    
    Features
    
    AlbedoColor
    
    Emission
    
    PerceptualRoughness
    
    Metalness
    
    CutOffValue
    
    Anisotropy
    
    UVScale
    
    AlbedoTexture
    
    NormalTexture
    
    ArmTexture
    
    EmissionTexture
    
    Sampler
  - EMaterialSidedness
    
    Single
    
    Double
  - ENormalMode
    
    Flip
    
    Mirror
    
    Off
  - EPrimitiveType
    
    Plane
    
    Sphere
    
    Cylinder
    
    Capsule
    
    Box
  - EToneMapper
    
    Off
    
    Reinhard
    
    Neutral
    
    ACES_1_3
    
    LUT
  - EnvironmentMapAsset
    
    Constructor
    
    layout
    
    multiplier
    
    rotation
    
    texture
    
    tint
    
    uuid
  - FrameAsset
    
    Constructor
    
    timeStamp
    
    transform_position
    
    transform_rotation
  - InstanceAsset
    
    Constructor
    
    convertAxis
    
    dynamicMesh_dynamicConnectivity
    
    dynamicMesh_numTriangles
    
    dynamicMesh_numVertices
    
    enabled
    
    matOverride
    
    mesh_uri
    
    name
    
    position
    
    primitive_type
    
    rotation
    
    scale
    
    smooth
    
    subscene_uri
    
    type
    
    uuid
  - LightAsset
    
    Constructor
    
    area_position
    
    area_range
    
    area_rotation
    
    area_shape
    
    color
    
    directional_direction
    
    intensity
    
    point_position
    
    point_range
    
    shadow
    
    spot_direction
    
    spot_innerAngle
    
    spot_outerAngle
    
    spot_position
    
    spot_range
    
    type
    
    unit
    
    uuid
  - LightFieldAsset
    
    Constructor
    
    position
    
    rotation
    
    scale
    
    tint
    
    type
    
    uri
    
    uuid
  - MaterialAsset
    
    Constructor
    
    clear_properties
    
    has_properties
    
    set_properties
    
    albedoColor
    
    albedoTexture
    
    anisotropy
    
    armTexture
    
    clipping
    
    cutOff
    
    emission
    
    emissionTexture
    
    features
    
    metalness
    
    normalMode
    
    normalTexture
    
    opacity
    
    perceptualRoughness
    
    sampler
    
    sidedness
    
    uvScale
  - SceneAsset
    
    Constructor
    
    animation_resize
    
    animation_size
    
    camera_resize
    
    camera_size
    
    env_map_resize
    
    env_map_size
    
    get_animation
    
    get_camera
    
    get_env_map
    
    get_instance
    
    get_light
    
    get_light_field
    
    instance_resize
    
    instance_size
    
    light_field_resize
    
    light_field_size
    
    light_resize
    
    light_size
    
    set_animation
    
    set_camera
    
    set_env_map
    
    set_instance
    
    set_light
    
    set_light_field
    
    rootFolder
    
    version
  - TransfromFrameData
    
    Constructor
    
    position
    
    rotation
  - float2
    
    float2()
    
    float2(x: float, y: float)
    
    x
    
    y
  - float3
    
    float3()
    
    float3(x: float, y: float, z: float)
    
    x
    
    y
    
    z
  - float4
    
    float4()
    
    float4(x: float, y: float, z: float, w: float)
    
    w
    
    x
    
    y
    
    z
  - quaternion
    
    quaternion()
    
    quaternion(x: float, y: float, z: float, w: float)
    
    w
    
    x
    
    y
    
    z
  - uint2
    
    uint2()
    
    uint2(x: int, y: int)
    
    x
    
    y
  - uint3
    
    uint3()
    
    uint3(x: int, y: int, z: int)
    
    x
    
    y
    
    z
  - uint4
    
    uint4()
    
    uint4(x: int, y: int, z: int, w: int)
    
    w
    
    x
    
    y
    
    z
- nyx_py_video_encoder
  - GPUVideoEncoder
    
    Constructor
    
    encode_frame_srgb_to_cpu
    
    force_next_frame_as_idr
    
    max_buffer_size
    
    next_frame_is_idr
    
    set_encoding_parameters
    
    shutdown
    
    startup
  - VideoEncoderStartupParams
    
    Constructor
    
    bitrate
    
    cudaDevice
    
    frameHeight
    
    frameRate
    
    frameWidth
    
    gopSize
gs_nyx_plugin

API reference
gs_nyx
nyx_py_sdk
SceneAsset
rootFolder

rootFolder#

property SceneAsset.rootFolder#: Root folder used to resolve relative asset paths within the scene.

previous

set_light_field

next

version

On this page

SceneAsset.rootFolder

© Copyright 2026, Genesis AI.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.17.1.