nyx_py_sdk

Nyx SDK Python bindings for authoring and serializing scene assets.

Functions

export_scene_file(path, scene)	Serialize 'scene' to JSON and write it to 'path'.
float3_y_up_a_to_z_up(v)	Convert a float3 from the Y-up (variant A) convention to a Z-up coordinate system.
float3_z_up_to_y_up_a(v)	Convert a float3 from a Z-up coordinate system to the Y-up (variant A) convention.
generate_uuid()	Return a fresh 64-bit UUID from the SDK's global generator.
import_scene_file(path, scene)	Load a JSON scene file from 'path' into the given SceneAsset.
quaternion_conjugate(q)	Return the conjugate of a quaternion (negated imaginary part).
quaternion_mul(a, b)	Return the Hamilton product a * b of two quaternions.
quaternion_wxyz_to_xyzw(q)	Reorder a quaternion stored as (w, x, y, z) into the (x, y, z, w) convention used by this SDK.
quaternion_xyzw_to_wxyz(q)	Reorder a quaternion stored as (x, y, z, w) into the (w, x, y, z) convention.
quaternion_y_up_a_to_z_up(q)	Convert a quaternion from the Y-up (variant A) convention to a Z-up coordinate system.
quaternion_z_up_to_y_up_a(q)	Convert a quaternion from a Z-up coordinate system to the Y-up (variant A) convention.
shutdown()	Shutdown the Nyx SDK
startup()	Initialize the Nyx SDK's global memory and string-cache subsystems.

Classes

AnimationAsset	An animation track bound to a target asset by UUID.
CameraAsset	A view of the scene defined by a transform, projection and post-processing settings.
EAnimationType	Kind of property animated by an AnimationAsset.
EAntiAliasing	Post-process anti-aliasing technique.
EAreaShape	Shape of an area light.
EEnvMapLayout	Pixel layout used by an environment map texture.
EInstanceType	Kind of instance, which selects the active type-specific fields on InstanceAsset.
ELightFieldType	Representation used by a LightFieldAsset.
ELightType	Kind of light source.
ELightUnit	Photometric unit used to interpret the light intensity.
EMaterialClipping	Alpha clipping mode used by a material.
EMaterialFeatures	Optional shading feature set enabled on a material.
EMaterialOpacity	Opacity mode used by a material.
EMaterialProperty	Bit flags identifying which fields of a MaterialAsset are explicitly set.
EMaterialSidedness	Face culling mode used by a material.
ENormalMode	How shading normals on back faces are derived from the front-face normal.
EPrimitiveType	Built-in analytic primitive type.
EToneMapper	Tone mapping operator applied to the final image.
EnvironmentMapAsset	Image-based environment map providing infinite-distance lighting.
FrameAsset	A single keyframe of an animation.
InstanceAsset	An instance placed in the scene.
LightAsset	A scene light.
LightFieldAsset	A captured radiance field placed in the scene.
MaterialAsset	A physically-based material description.
SceneAsset	Top-level scene container holding all instances, lights, cameras, environment maps, animations and light fields.
TransfromFrameData	Transform sample at a single animation frame.
float2	Two-component single-precision float vector (x, y).
float3	Three-component single-precision float vector (x, y, z).
float4	Four-component single-precision float vector (x, y, z, w).
quaternion	Quaternion stored as (x, y, z, w) with w as the scalar component.
uint2	Two-component unsigned integer vector (x, y).
uint3	Three-component unsigned integer vector (x, y, z).
uint4	Four-component unsigned integer vector (x, y, z, w).