NodesΒΆ

AnimatedBuffer*ΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameBuffer)

key frame buffers to interpolate from

Source: src/node_animatedbuffer.c

List of AnimatedBuffer* nodes:

  • AnimatedBufferFloat

  • AnimatedBufferVec2

  • AnimatedBufferVec3

  • AnimatedBufferVec4

AnimatedColorΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameColor)

color key frames to interpolate from

space

colorspace

color space defining how to interpret value

srgb

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedPathΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameFloat)

float key frames to interpolate from, representing the normed distance from the start of the path

path

nonull

node (Path, SmoothPath)

path to follow

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedTimeΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameFloat)

time key frames to interpolate from

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedFloatΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameFloat)

float key frames to interpolate from

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedVec2ΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameVec2)

vec2 key frames to interpolate from

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedVec3ΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameVec3)

vec3 key frames to interpolate from

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedVec4ΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameVec4)

vec4 key frames to interpolate from

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimatedQuatΒΆ

Parameter

Flags

Type

Description

Default

keyframes

node_list (AnimKeyFrameQuat)

quaternion key frames to interpolate from

as_mat4

bool

exposed as a 4x4 rotation matrix in the program

0

time_offset

f64

apply a time offset before evaluating the animation

0

Source: src/node_animated.c

AnimKeyFrameFloatΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

value

f64

the value at time time

0

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameVec2ΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

value

vec2

the value at time time

(0,0)

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameVec3ΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

value

vec3

the value at time time

(0,0,0)

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameVec4ΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

value

vec4

the value at time time

(0,0,0,0)

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameQuatΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

quat

vec4

the quat at time time

(0,0,0,0)

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameColorΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

color

vec3

the color at time time

(0,0,0)

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

AnimKeyFrameBufferΒΆ

Parameter

Flags

Type

Description

Default

time

f64

the time key point in seconds

0

data

data

the data at time time

easing

easing

easing interpolation from previous key frame

linear

easing_args

f64_list

a list of arguments some easings may use

easing_start_offset

f64

starting offset of the truncation of the easing

0

easing_end_offset

f64

ending offset of the truncation of the easing

1

Source: src/node_animkeyframe.c

BlockΒΆ

Parameter

Flags

Type

Description

Default

fields

node_list (AnimatedBufferFloat, AnimatedBufferVec2, AnimatedBufferVec3, AnimatedBufferVec4, StreamedBufferInt, StreamedBufferIVec2, StreamedBufferIVec3, StreamedBufferIVec4, StreamedBufferUInt, StreamedBufferUIVec2, StreamedBufferUIVec3, StreamedBufferUIVec4, StreamedBufferFloat, StreamedBufferVec2, StreamedBufferVec3, StreamedBufferVec4, BufferFloat, BufferVec2, BufferVec3, BufferVec4, BufferInt, BufferIVec2, BufferIVec3, BufferIVec4, BufferUInt, BufferUIVec2, BufferUIVec3, BufferUIVec4, BufferMat4, UniformBool, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformInt, UniformIVec2, UniformIVec3, UniformIVec4, UniformUInt, UniformUIVec2, UniformUIVec3, UniformUIVec4, UniformMat4, UniformQuat, UniformColor, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, AnimatedQuat, AnimatedColor, StreamedInt, StreamedIVec2, StreamedIVec3, StreamedIVec4, StreamedUInt, StreamedUIVec2, StreamedUIVec3, StreamedUIVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, StreamedMat4, Time)

block fields defined in the graphic program

layout

memory_layout

memory layout set in the graphic program

std140

Source: src/node_block.c

Buffer*ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements

0

data

data

buffer of count elements

filename

str

filename from which the buffer will be read, cannot be used with data

block

node (Block)

reference a field from the given block

block_field

str

field name in block

Source: src/node_buffer.c

List of Buffer* nodes:

  • BufferByte

  • BufferBVec2

  • BufferBVec3

  • BufferBVec4

  • BufferInt

  • BufferInt64

  • BufferIVec2

  • BufferIVec3

  • BufferIVec4

  • BufferShort

  • BufferSVec2

  • BufferSVec3

  • BufferSVec4

  • BufferUByte

  • BufferUBVec2

  • BufferUBVec3

  • BufferUBVec4

  • BufferUInt

  • BufferUIVec2

  • BufferUIVec3

  • BufferUIVec4

  • BufferUShort

  • BufferUSVec2

  • BufferUSVec3

  • BufferUSVec4

  • BufferFloat

  • BufferVec2

  • BufferVec3

  • BufferVec4

  • BufferMat4

CameraΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to observe through the lens of the camera

eye

live node

vec3

eye position

(0,0,0)

center

live node

vec3

center position

(0,0,-1)

up

live node

vec3

up vector, must not be parallel to the line of sight from the eye point to the center point

(0,1,0)

perspective

live node

vec2

the 2 following values: fov, aspect

(0,0)

orthographic

live

vec4

the 4 following values: left, right, bottom, top

(0,0,0,0)

clipping

live

vec2

the 2 following values: near clipping plane, far clipping plane

(0,0)

eye_transform

node (Rotate, RotateQuat, Transform, Translate, Scale, Skew, Identity)

eye transformation chain

center_transform

node (Rotate, RotateQuat, Transform, Translate, Scale, Skew, Identity)

center transformation chain

up_transform

node (Rotate, RotateQuat, Transform, Translate, Scale, Skew, Identity)

up transformation chain

Source: src/node_camera.c

CircleΒΆ

Parameter

Flags

Type

Description

Default

radius

f32

circle radius

1

npoints

i32

number of points

16

Source: src/node_circle.c

ColorKeyΒΆ

Parameter

Flags

Type

Description

Default

position

live node

f32

position of the gradient point on the axis (within [0;1])

0

color

live node

vec3

color at this specific position

(1,1,1)

opacity

live node

f32

opacity at this specific position

1

Source: src/node_colorkey.c

ColorStatsΒΆ

Parameter

Flags

Type

Description

Default

texture

nonull

node (Texture2D)

source texture to compute the color stats from

Source: src/node_colorstats.c

ComputeΒΆ

Parameter

Flags

Type

Description

Default

workgroup_count

uvec3

number of work groups to be executed

(0,0,0)

program

nonull

node (ComputeProgram)

compute program to be executed

resources

node_dict (Texture2D, Texture2DArray, Texture3D, TextureCube, Block, ColorStats, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, UniformQuat, UniformBool, UniformInt, UniformIVec2, UniformIVec3, UniformIVec4, UniformUInt, UniformUIVec2, UniformUIVec3, UniformUIVec4, UniformMat4, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, AnimatedQuat, AnimatedColor, NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, StreamedInt, StreamedIVec2, StreamedIVec3, StreamedIVec4, StreamedUInt, StreamedUIVec2, StreamedUIVec3, StreamedUIVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, StreamedMat4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the compute program

Source: src/node_compute.c

ComputeProgramΒΆ

Parameter

Flags

Type

Description

Default

compute

nonull

str

compute shader

workgroup_size

ivec3

number of local compute instances in a work group

(0,0,0)

properties

node_dict (ResourceProps)

resource properties

Source: src/node_computeprogram.c

FilterAlphaΒΆ

Parameter

Flags

Type

Description

Default

alpha

live node

f32

alpha channel value

1

Source: src/node_filters.c

FilterColorMapΒΆ

Parameter

Flags

Type

Description

Default

colorkeys

node_list (ColorKey)

color keys to interpolate from

Source: src/node_filters.c

FilterContrastΒΆ

Parameter

Flags

Type

Description

Default

contrast

live node

f32

perceptual contrast value

1

pivot

live node

f32

pivot point between light and dark

0.5

Source: src/node_filters.c

FilterExposureΒΆ

Parameter

Flags

Type

Description

Default

exposure

live node

f32

exposure

0

Source: src/node_filters.c

FilterInverseAlphaΒΆ

Source: src/node_filters.c

FilterLinear2sRGBΒΆ

Source: src/node_filters.c

FilterOpacityΒΆ

Parameter

Flags

Type

Description

Default

opacity

live node

f32

opacity value (color gets premultiplied by this value)

1

Source: src/node_filters.c

FilterPremultΒΆ

Source: src/node_filters.c

FilterSaturationΒΆ

Parameter

Flags

Type

Description

Default

saturation

live node

f32

saturation

1

Source: src/node_filters.c

FilterSelectorΒΆ

Parameter

Flags

Type

Description

Default

range

live node

vec2

values within this range are selected

(0,1)

component

selector_component

reference component for the selector comparison

lightness

drop_mode

selector_drop

define how to interpret the range selector

outside

output_mode

selector_output

define the output color

colorholes

smoothedges

live node

bool

make edges less sharp

0

Source: src/node_filters.c

FilterSRGB2LinearΒΆ

Source: src/node_filters.c

FastGaussianBlurΒΆ

Parameter

Flags

Type

Description

Default

source

nonull

node (Texture2D)

source to use for the blur

destination

nonull

node (Texture2D)

destination to use for the blur

bluriness

node

f32

amount of bluriness in the range [0, 1]

0.03

Source: src/node_fgblur.c

GaussianBlurΒΆ

Parameter

Flags

Type

Description

Default

source

nonull

node (Texture2D)

source to use for the blur

destination

nonull

node (Texture2D)

destination to use for the blur

bluriness

node

f32

amount of bluriness in the range [0,1] where 1 is equivalent of a blur radius of 126px

0.03

Source: src/node_gblur.c

GeometryΒΆ

Parameter

Flags

Type

Description

Default

vertices

nonull

node (BufferVec3, AnimatedBufferVec3)

vertice coordinates defining the geometry

uvcoords

node (BufferFloat, BufferVec2, BufferVec3, AnimatedBufferFloat, AnimatedBufferVec2, AnimatedBufferVec3)

coordinates used for UV mapping of each vertices

normals

node (BufferVec3, AnimatedBufferVec3)

normal vectors of each vertices

indices

node (BufferUShort, BufferUInt)

indices defining the drawing order of the vertices, auto-generated if not set

topology

topology

primitive topology

triangle_list

Source: src/node_geometry.c

GraphicConfigΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to which the graphic configuration will be applied

blend

bool

enable blending

unset

blend_src_factor

blend_factor

blend source factor

unset

blend_dst_factor

blend_factor

blend destination factor

unset

blend_src_factor_a

blend_factor

alpha blend source factor

unset

blend_dst_factor_a

blend_factor

alpha blend destination factor

unset

blend_op

blend_operation

blend operation

unset

blend_op_a

blend_operation

alpha blend operation

unset

color_write_mask

component

color write mask

unset

depth_test

bool

enable depth testing

unset

depth_write_mask

bool

depth write mask

unset

depth_func

function

passes if <function>(depth, stored_depth)

unset

stencil_test

bool

enable stencil testing

unset

stencil_write_mask

i32

stencil write mask, must be in the range [0, 0xff]

-1

stencil_func

function

passes if <function>(stencil_ref & stencil_read_mask, stencil & stencil_read_mask)

unset

stencil_ref

i32

stencil reference value to compare against

-1

stencil_read_mask

i32

stencil read mask, must be in the range [0, 0xff]

-1

stencil_fail

stencil_operation

operation to execute if stencil test fails

unset

stencil_depth_fail

stencil_operation

operation to execute if depth test fails

unset

stencil_depth_pass

stencil_operation

operation to execute if stencil and depth test pass

unset

cull_mode

cull_mode

face culling mode

unset

scissor_test

bool

enable scissor testing

unset

scissor

ivec4

define an area where all pixels outside are discarded

(-1,-1,-1,-1)

Source: src/node_graphicconfig.c

GridLayoutΒΆ

Parameter

Flags

Type

Description

Default

children

node_list

a set of scenes

size

ivec2

number of cols and rows in the grid

(-1,-1)

Source: src/node_gridlayout.c

GroupΒΆ

Parameter

Flags

Type

Description

Default

children

node_list

a set of scenes

Source: src/node_group.c

IdentityΒΆ

Source: src/node_identity.c

IOVar*ΒΆ

Parameter

Flags

Type

Description

Default

precision_out

precision

precision qualifier for the output side (vertex)

auto

precision_in

precision

precision qualifier for the input side (fragment)

auto

Source: src/node_io.c

List of IOVar* nodes:

  • IOInt

  • IOIVec2

  • IOIVec3

  • IOIVec4

  • IOUInt

  • IOUIvec2

  • IOUIvec3

  • IOUIvec4

  • IOFloat

  • IOVec2

  • IOVec3

  • IOVec4

  • IOMat3

  • IOMat4

  • IOBool

EvalFloatΒΆ

Parameter

Flags

Type

Description

Default

expr0

nonull

str

expression to evaluate

β€œ0”

resources

node_dict (NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the expr0

Source: src/node_eval.c

EvalVec2ΒΆ

Parameter

Flags

Type

Description

Default

expr0

nonull

str

expression to evaluate to define 1st component

β€œ0”

expr1

str

expression to evaluate to define 2nd component

resources

node_dict (NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the expr0 and expr1

Source: src/node_eval.c

EvalVec3ΒΆ

Parameter

Flags

Type

Description

Default

expr0

nonull

str

expression to evaluate to define 1st component

β€œ0”

expr1

str

expression to evaluate to define 2nd component

expr2

str

expression to evaluate to define 3rd component

resources

node_dict (NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the expr0, expr1 and expr2

Source: src/node_eval.c

EvalVec4ΒΆ

Parameter

Flags

Type

Description

Default

expr0

nonull

str

expression to evaluate to define 1st component

β€œ0”

expr1

str

expression to evaluate to define 2nd component

expr2

str

expression to evaluate to define 3rd component

expr3

str

expression to evaluate to define 4th component

resources

node_dict (NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the expr0, expr1, expr2 and expr3

Source: src/node_eval.c

MediaΒΆ

Parameter

Flags

Type

Description

Default

filename

nonull

str

path to input media file

nopemd_min_level

nopemd_log_level

nope.media min logging level

warning

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

audio_tex

bool

load the audio and expose it as a stereo waves and frequencies buffer

0

max_nb_packets

i32

maximum number of packets in nope.media demuxing queue

1

max_nb_frames

i32

maximum number of frames in nope.media decoding queue

1

max_nb_sink

i32

maximum number of frames in nope.media filtering queue

1

max_pixels

i32

maximum number of pixels per frame

0

stream_idx

i32

force a stream number instead of picking the β€œbest” one

-1

hwaccel

nopemd_hwaccel

hardware acceleration

auto

filters

str

filters to apply on the media (nope.media/libavfilter)

vt_pix_fmt

str

auto or a comma or space separated list of VideoToolbox (Apple) allowed output pixel formats

β€œauto”

Source: src/node_media.c

Noise*ΒΆ

Parameter

Flags

Type

Description

Default

frequency

live

f32

oscillation per second

1

amplitude

live

f32

by how much it oscillates

1

octaves

live

i32

number of accumulated noise layers (controls the level of details)

3

lacunarity

live

f32

frequency multiplier per octave

2

gain

live

f32

amplitude multiplier per octave (also known as persistence)

0.5

seed

u32

random base seed (acts as an offsetting to the time)

0

interpolant

interp_noise

interpolation function to use between noise points

quintic

Source: src/node_noise.c

List of Noise* nodes:

  • NoiseFloat

  • NoiseVec2

  • NoiseVec3

  • NoiseVec4

PathΒΆ

Parameter

Flags

Type

Description

Default

keyframes

nonull

node_list (PathKeyMove, PathKeyLine, PathKeyBezier2, PathKeyBezier3, PathKeyClose)

anchor points the path go through

precision

i32

number of divisions per curve segment

64

Source: src/node_path.c

PathKeyBezier2ΒΆ

Parameter

Flags

Type

Description

Default

control

vec3

control point

(0,0,0)

to

vec3

end point of the curve, new cursor position

(0,0,0)

Source: src/node_pathkey.c

PathKeyBezier3ΒΆ

Parameter

Flags

Type

Description

Default

control1

vec3

first control point

(0,0,0)

control2

vec3

second control point

(0,0,0)

to

vec3

end point of the curve, new cursor position

(0,0,0)

Source: src/node_pathkey.c

PathKeyCloseΒΆ

Source: src/node_pathkey.c

PathKeyLineΒΆ

Parameter

Flags

Type

Description

Default

to

vec3

end point of the line, new cursor position

(0,0,0)

Source: src/node_pathkey.c

PathKeyMoveΒΆ

Parameter

Flags

Type

Description

Default

to

vec3

new cursor position

(0,0,0)

Source: src/node_pathkey.c

ProgramΒΆ

Parameter

Flags

Type

Description

Default

vertex

nonull

str

vertex shader

fragment

nonull

str

fragment shader

properties

node_dict (ResourceProps)

resource properties

vert_out_vars

node_dict (IOInt, IOIVec2, IOIVec3, IOIVec4, IOUInt, IOUIvec2, IOUIvec3, IOUIvec4, IOFloat, IOVec2, IOVec3, IOVec4, IOMat3, IOMat4, IOBool)

in/out communication variables shared between vertex and fragment stages

nb_frag_output

i32

number of color outputs in the fragment shader

0

Source: src/node_program.c

QuadΒΆ

Parameter

Flags

Type

Description

Default

corner

vec3

origin coordinates of width and height vectors

(-0.5,-0.5,0)

width

vec3

width vector

(1,0,0)

height

vec3

height vector

(0,1,0)

uv_corner

vec2

origin coordinates of uv_width and uv_height vectors

(0,0)

uv_width

vec2

UV coordinates width vector

(1,0)

uv_height

vec2

UV coordinates height vector

(0,1)

Source: src/node_quad.c

RenderΒΆ

Parameter

Flags

Type

Description

Default

geometry

nonull

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

program

nonull

node (Program)

program to be executed

vert_resources

node_dict (Texture2D, Texture2DArray, Texture3D, TextureCube, Block, ColorStats, BufferFloat, BufferVec2, BufferVec3, BufferVec4, NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, StreamedBufferInt, StreamedBufferIVec2, StreamedBufferIVec3, StreamedBufferIVec4, StreamedBufferUInt, StreamedBufferUIVec2, StreamedBufferUIVec3, StreamedBufferUIVec4, StreamedBufferFloat, StreamedBufferVec2, StreamedBufferVec3, StreamedBufferVec4, UniformBool, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, UniformQuat, UniformInt, UniformIVec2, UniformIVec3, UniformIVec4, UniformUInt, UniformUIVec2, UniformUIVec3, UniformUIVec4, UniformMat4, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, AnimatedQuat, AnimatedColor, StreamedInt, StreamedIVec2, StreamedIVec3, StreamedIVec4, StreamedUInt, StreamedUIVec2, StreamedUIVec3, StreamedUIVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, StreamedMat4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the vertex stage of the program

frag_resources

node_dict (Texture2D, Texture2DArray, Texture3D, TextureCube, Block, ColorStats, BufferFloat, BufferVec2, BufferVec3, BufferVec4, NoiseFloat, NoiseVec2, NoiseVec3, NoiseVec4, EvalFloat, EvalVec2, EvalVec3, EvalVec4, StreamedBufferInt, StreamedBufferIVec2, StreamedBufferIVec3, StreamedBufferIVec4, StreamedBufferUInt, StreamedBufferUIVec2, StreamedBufferUIVec3, StreamedBufferUIVec4, StreamedBufferFloat, StreamedBufferVec2, StreamedBufferVec3, StreamedBufferVec4, UniformBool, UniformFloat, UniformVec2, UniformVec3, UniformVec4, UniformColor, UniformQuat, UniformInt, UniformIVec2, UniformIVec3, UniformIVec4, UniformUInt, UniformUIVec2, UniformUIVec3, UniformUIVec4, UniformMat4, AnimatedFloat, AnimatedVec2, AnimatedVec3, AnimatedVec4, AnimatedQuat, AnimatedColor, StreamedInt, StreamedIVec2, StreamedIVec3, StreamedIVec4, StreamedUInt, StreamedUIVec2, StreamedUIVec3, StreamedUIVec4, StreamedFloat, StreamedVec2, StreamedVec3, StreamedVec4, StreamedMat4, Time, VelocityFloat, VelocityVec2, VelocityVec3, VelocityVec4)

resources made accessible to the fragment stage of the program

attributes

node_dict (BufferFloat, BufferVec2, BufferVec3, BufferVec4, BufferMat4)

extra vertex attributes made accessible to the program

instance_attributes

node_dict (BufferFloat, BufferVec2, BufferVec3, BufferVec4, BufferMat4)

per instance extra vertex attributes made accessible to the program

nb_instances

i32

number of instances to draw

1

blending

blend_preset

define how this node and the current frame buffer are blended together

default

Source: src/node_render.c

RenderColorΒΆ

Parameter

Flags

Type

Description

Default

color

live node

vec3

color of the shape

(1,1,1)

opacity

live node

f32

opacity of the color

1

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderDisplaceΒΆ

Parameter

Flags

Type

Description

Default

source

nonull

node (Texture2D)

source texture to displace

displacement

nonull

node (Texture2D)

displacement vectors stored in a texture

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderGradientΒΆ

Parameter

Flags

Type

Description

Default

color0

live node

vec3

color of the first point

(0,0,0)

color1

live node

vec3

color of the second point

(1,1,1)

opacity0

live node

f32

opacity of the first color

1

opacity1

live node

f32

opacity of the second color

1

pos0

live node

vec2

position of the first point (in UV coordinates)

(0,0.5)

pos1

live node

vec2

position of the second point (in UV coordinates)

(1,0.5)

mode

gradient_mode

mode of interpolation between the two points

ramp

linear

live node

bool

interpolate colors linearly

1

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderGradient4ΒΆ

Parameter

Flags

Type

Description

Default

color_tl

live node

vec3

top-left color

(1,0.5,0)

color_tr

live node

vec3

top-right color

(0,1,0)

color_br

live node

vec3

bottom-right color

(0,0.5,1)

color_bl

live node

vec3

bottom-left color

(1,0,1)

opacity_tl

live node

f32

opacity of the top-left color

1

opacity_tr

live node

f32

opacity of the top-right color

1

opacity_br

live node

f32

opacity of the bottom-right color

1

opacity_bl

live node

f32

opacity of the bottol-left color

1

linear

live node

bool

interpolate colors linearly

1

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderHistogramΒΆ

Parameter

Flags

Type

Description

Default

stats

nonull

node (ColorStats)

texture to render

mode

scope_mode

define how to represent the data

mixed

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderNoiseΒΆ

Parameter

Flags

Type

Description

Default

type

noise_type

noise type

blocky

amplitude

node

f32

by how much it oscillates

1

octaves

u32

number of accumulated noise layers (controls the level of details), must in [1;8]

3

lacunarity

node

f32

frequency multiplier per octave

2

gain

node

f32

amplitude multiplier per octave (also known as persistence)

0.5

seed

node

u32

random base seed

0

scale

node

vec2

size of the grid in lattice units

(32,32)

evolution

node

f32

evolution of the 3rd non-spatial dimension, time if unspecified

0

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderPathΒΆ

Parameter

Flags

Type

Description

Default

path

nonull

node (Path, SmoothPath)

path to draw

viewbox

vec4

vector space for interpreting the path (x, y, width, height)

(-1,-1,2,2)

pt_size

i32

size in point (nominal size, 1pt = 1/72 inch)

54

dpi

i32

resolution (dot per inch)

300

aspect_ratio

ivec2

aspect ratio

(1,1)

color

live node

vec3

path fill color

(1,1,1)

opacity

live node

f32

path fill opacity

1

outline

live node

f32

path outline width

0.005

outline_color

live node

vec3

path outline color

(1,0.7,0)

glow

live node

f32

path glow width

0

glow_color

live node

vec3

path glow color

(1,1,1)

blur

live node

f32

path blur

0

Source: src/node_renderpath.c

RenderTextureΒΆ

Parameter

Flags

Type

Description

Default

texture

nonull

node (Texture2D)

texture to render

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

RenderToTextureΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to be rasterized to color_textures and optionally to depth_texture

color_textures

node_list (Texture2D, Texture2DArray, Texture3D, TextureCube, TextureView)

destination color texture

depth_texture

node (Texture2D, TextureView)

destination depth (and potentially combined stencil) texture

samples

i32

number of samples used for multisampling anti-aliasing

0

clear_color

vec4

color used to clear the color_texture

(0,0,0,0)

forward_transforms

bool

enable forwarding of camera/model transformations

0

Source: src/node_rtt.c

RenderWaveformΒΆ

Parameter

Flags

Type

Description

Default

stats

nonull

node (ColorStats)

texture to render

mode

scope_mode

define how to represent the data

mixed

blending

blend_preset

define how this node and the current frame buffer are blending together

default

geometry

node (Circle, Geometry, Quad, Triangle)

geometry to be rasterized

filters

node_list (FilterAlpha, FilterColorMap, FilterContrast, FilterExposure, FilterInverseAlpha, FilterLinear2sRGB, FilterOpacity, FilterPremult, FilterSaturation, FilterSelector, FilterSRGB2Linear)

filter chain to apply on top of this source

Source: src/node_renderother.c

ResourcePropsΒΆ

Parameter

Flags

Type

Description

Default

precision

precision

precision qualifier for the shader

auto

as_image

bool

flag this resource for image accessing (only applies to texture nodes)

0

writable

bool

flag this resource as writable in the shader

0

Source: src/node_resourceprops.c

RotateΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to rotate

angle

live node

f32

rotation angle in degrees

0

axis

vec3

rotation axis

(0,0,1)

anchor

vec3

vector to the center point of the rotation

(0,0,0)

Source: src/node_rotate.c

RotateQuatΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to rotate

quat

live node

vec4

quaternion

(0,0,0,1)

anchor

vec3

vector to the center point of the rotation

(0,0,0)

Source: src/node_rotatequat.c

ScaleΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to scale

factors

live node

vec3

scaling factors (how much to scale on each axis)

(1,1,1)

anchor

vec3

vector to the center point of the scale

(0,0,0)

Source: src/node_scale.c

SkewΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to skew

angles

live node

vec3

skewing angles, only components forming a plane opposite to axis should be set

(0,0,0)

axis

vec3

skew axis

(1,0,0)

anchor

vec3

vector to the center point of the skew

(0,0,0)

Source: src/node_skew.c

SmoothPathΒΆ

Parameter

Flags

Type

Description

Default

points

nonull

node (BufferVec3)

anchor points the path go through

control1

vec3

initial control point

(0,0,0)

control2

vec3

final control point

(0,0,0)

precision

i32

number of divisions per curve segment

64

tension

f32

tension between points

0.5

Source: src/node_smoothpath.c

TextΒΆ

Parameter

Flags

Type

Description

Default

text

live nonull

str

text string to rasterize

β€œβ€

live_id

str

live control identifier

fg_color

live

vec3

foreground text color

(1,1,1)

fg_opacity

live

f32

foreground text opacity

1

bg_color

live

vec3

background text color

(0,0,0)

bg_opacity

live

f32

background text opacity

0.8

box_corner

vec3

origin coordinates of box_width and box_height vectors

(-1,-1,0)

box_width

vec3

box width vector

(2,0,0)

box_height

vec3

box height vector

(0,2,0)

font_files

str

paths to font files (use β€˜,’ or β€˜;’ to separate paths, require build with external text libraries)

padding

i32

padding around the text, in point units

4

pt_size

i32

characters size in point (nominal size, 1pt = 1/72 inch)

54

dpi

i32

resolution (dot per inch)

96

font_scale

f32

scaling of the font

1

scale_mode

scale_mode

scaling behaviour for the characters

auto

effects

node_list (TextEffect)

stack of effects

valign

valign

vertical alignment of the text in the box

center

halign

halign

horizontal alignment of the text in the box

center

writing_mode

writing_mode

direction flow per character and line

horizontal-tb

aspect_ratio

live

rational

box aspect ratio

0/0

Source: src/node_text.c

TextEffectΒΆ

Parameter

Flags

Type

Description

Default

start

f64

absolute start time of the effect

0

end

f64

absolute end time of the effect, negative for scene duration

-1

target

text_target

segmentation target of the effect

text

random

bool

randomize the order the effect are applied on the target

0

random_seed

u32

random seed for the random parameter

0

start_pos

live node

f32

normalized text position where the effect starts

0

end_pos

live node

f32

normalized text position where the effect ends

1

overlap

live node

f32

overlap factor between target elements

0

transform

node (Rotate, RotateQuat, Transform, Translate, Scale, Skew, Identity)

transformation chain

color

live node

vec3

characters fill color, use negative values for unchanged from previous text effects (default is Text.fg_color)

(-1,-1,-1)

opacity

live node

f32

characters opacity, use negative value for unchanged from previous text effects (default is Text.opacity)

-1

outline

live node

f32

characters outline width, use negative value for unchanged from previous text effects (default is 0)

-1

outline_color

live node

vec3

characters outline color, use negative value for unchanged from previous text effects (default is yellow, (1, 1, 0))

(-1,-1,-1)

glow

live node

f32

characters glow width, use negative value for unchanged from previous text effects (default is 0)

-1

glow_color

live node

vec3

characters glow color, use negative value for unchanged from previous text effects (default is white, (1, 1, 1))

(-1,-1,-1)

blur

live node

f32

characters blur, use negative value for unchanged from previous text effects (default is 0)

-1

Source: src/node_texteffect.c

Texture2DΒΆ

Parameter

Flags

Type

Description

Default

format

format

format of the pixel data

r8g8b8a8_unorm

width

i32

width of the texture

0

height

i32

height of the texture

0

min_filter

filter

texture minifying function

linear

mag_filter

filter

texture magnification function

linear

mipmap_filter

mipmap_filter

texture minifying mipmap function

none

wrap_s

wrap

wrap parameter for the texture on the s dimension (horizontal)

clamp_to_edge

wrap_t

wrap

wrap parameter for the texture on the t dimension (vertical)

clamp_to_edge

data_src

node

data source

direct_rendering

bool

whether direct rendering is allowed or not for media playback

1

clamp_video

bool

clamp ngl_texvideo() output to [0;1]

0

clear_color

vec4

color used to clear the texture when used as an implicit render target

(0,0,0,0)

forward_transforms

bool

enable forwarding of camera/model transformations when used as an implicit render target

0

Source: src/node_texture.c

Texture2DArrayΒΆ

Parameter

Flags

Type

Description

Default

format

format

format of the pixel data

r8g8b8a8_unorm

width

i32

width of the texture

0

height

i32

height of the texture

0

depth

i32

depth of the texture

0

min_filter

filter

texture minifying function

linear

mag_filter

filter

texture magnification function

linear

mipmap_filter

mipmap_filter

texture minifying mipmap function

none

wrap_s

wrap

wrap parameter for the texture on the s dimension (horizontal)

clamp_to_edge

wrap_t

wrap

wrap parameter for the texture on the t dimension (vertical)

clamp_to_edge

wrap_r

wrap

wrap parameter for the texture on the r dimension (depth)

clamp_to_edge

data_src

node (AnimatedBufferFloat, AnimatedBufferVec2, AnimatedBufferVec4, BufferByte, BufferBVec2, BufferBVec4, BufferInt, BufferIVec2, BufferIVec4, BufferShort, BufferSVec2, BufferSVec4, BufferUByte, BufferUBVec2, BufferUBVec4, BufferUInt, BufferUIVec2, BufferUIVec4, BufferUShort, BufferUSVec2, BufferUSVec4, BufferFloat, BufferVec2, BufferVec4)

data source

Source: src/node_texture.c

Texture3DΒΆ

Parameter

Flags

Type

Description

Default

format

format

format of the pixel data

r8g8b8a8_unorm

width

i32

width of the texture

0

height

i32

height of the texture

0

depth

i32

depth of the texture

0

min_filter

filter

texture minifying function

linear

mag_filter

filter

texture magnification function

linear

mipmap_filter

mipmap_filter

texture minifying mipmap function

none

wrap_s

wrap

wrap parameter for the texture on the s dimension (horizontal)

clamp_to_edge

wrap_t

wrap

wrap parameter for the texture on the t dimension (vertical)

clamp_to_edge

wrap_r

wrap

wrap parameter for the texture on the r dimension (depth)

clamp_to_edge

data_src

node (AnimatedBufferFloat, AnimatedBufferVec2, AnimatedBufferVec4, BufferByte, BufferBVec2, BufferBVec4, BufferInt, BufferIVec2, BufferIVec4, BufferShort, BufferSVec2, BufferSVec4, BufferUByte, BufferUBVec2, BufferUBVec4, BufferUInt, BufferUIVec2, BufferUIVec4, BufferUShort, BufferUSVec2, BufferUSVec4, BufferFloat, BufferVec2, BufferVec4)

data source

Source: src/node_texture.c

TextureCubeΒΆ

Parameter

Flags

Type

Description

Default

format

format

format of the pixel data

r8g8b8a8_unorm

size

i32

width and height of the texture

0

min_filter

filter

texture minifying function

linear

mag_filter

filter

texture magnification function

linear

mipmap_filter

mipmap_filter

texture minifying mipmap function

none

wrap_s

wrap

wrap parameter for the texture on the s dimension (horizontal)

clamp_to_edge

wrap_t

wrap

wrap parameter for the texture on the t dimension (vertical)

clamp_to_edge

wrap_r

wrap

wrap parameter for the texture on the r dimension (depth)

clamp_to_edge

data_src

node (AnimatedBufferFloat, AnimatedBufferVec2, AnimatedBufferVec4, BufferByte, BufferBVec2, BufferBVec4, BufferInt, BufferIVec2, BufferIVec4, BufferShort, BufferSVec2, BufferSVec4, BufferUByte, BufferUBVec2, BufferUBVec4, BufferUInt, BufferUIVec2, BufferUIVec4, BufferUShort, BufferUSVec2, BufferUSVec4, BufferFloat, BufferVec2, BufferVec4)

data source

Source: src/node_texture.c

TextureViewΒΆ

Parameter

Flags

Type

Description

Default

texture

nonull

node (Texture2D, Texture2DArray, Texture3D, TextureCube)

texture used for the view

layer

i32

texture layer used for the view

0

Source: src/node_textureview.c

TimeΒΆ

Source: src/node_time.c

TimeRangeFilterΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

time filtered scene

start

f64

start time (included) for the scene to be drawn

0

end

f64

end time (excluded) for the scene to be drawn, a negative value implies forever

-1

render_time

f64

chosen time to draw for a β€œonce” mode, negative to ignore

-1

prefetch_time

f64

child is prefetched prefetch_time seconds in advance

1

Source: src/node_timerangefilter.c

TransformΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to apply the transform to

matrix

live node

mat4

transformation matrix

(1,0,0,0 0,1,0,0 0,0,1,0 0,0,0,1)

Source: src/node_transform.c

TranslateΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to translate

vector

live node

vec3

translation vector

(0,0,0)

Source: src/node_translate.c

TriangleΒΆ

Parameter

Flags

Type

Description

Default

edge0

vec3

first edge coordinate of the triangle

(1,-1,0)

edge1

vec3

second edge coordinate of the triangle

(0,1,0)

edge2

vec3

third edge coordinate of the triangle

(-1,-1,0)

uv_edge0

vec2

UV coordinate associated with edge0

(0,0)

uv_edge1

vec2

UV coordinate associated with edge1

(0,1)

uv_edge2

vec2

UV coordinate associated with edge2

(1,1)

Source: src/node_triangle.c

StreamedIntΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferInt)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedIVec2ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedIVec3ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedIVec4ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedUIntΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUInt)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedUIVec2ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedUIVec3ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedUIVec4ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedFloatΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferFloat)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedVec2ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedVec3ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedVec4ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedMat4ΒΆ

Parameter

Flags

Type

Description

Default

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferMat4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamed.c

StreamedBufferIntΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferInt)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferIVec2ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferIVec3ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferIVec4ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferIVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferUIntΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUInt)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferUIVec2ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferUIVec3ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferUIVec4ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferUIVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferFloatΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferFloat)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferVec2ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec2)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferVec3ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec3)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferVec4ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferVec4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

StreamedBufferMat4ΒΆ

Parameter

Flags

Type

Description

Default

count

i32

number of elements for each chunk of data to stream

0

timestamps

nonull

node (BufferInt64)

timestamps associated with each chunk of data to stream

buffer

nonull

node (BufferMat4)

buffer containing the data to stream

timebase

rational

time base in which the timestamps are represented

1/1000000

time_anim

node (AnimatedTime)

time remapping animation (must use a linear interpolation)

Source: src/node_streamedbuffer.c

UniformBoolΒΆ

Parameter

Flags

Type

Description

Default

value

live

bool

value exposed to the shader

0

live_id

str

live control identifier

Source: src/node_uniform.c

UniformIntΒΆ

Parameter

Flags

Type

Description

Default

value

live

i32

value exposed to the shader

0

live_id

str

live control identifier

live_min

i32

minimum value allowed during live change (only honored when live_id is set)

-100

live_max

i32

maximum value allowed during live change (only honored when live_id is set)

100

Source: src/node_uniform.c

UniformIVec2ΒΆ

Parameter

Flags

Type

Description

Default

value

live

ivec2

value exposed to the shader

(0,0)

live_id

str

live control identifier

live_min

ivec2

minimum value allowed during live change (only honored when live_id is set)

(-100,-100)

live_max

ivec2

maximum value allowed during live change (only honored when live_id is set)

(100,100)

Source: src/node_uniform.c

UniformIVec3ΒΆ

Parameter

Flags

Type

Description

Default

value

live

ivec3

value exposed to the shader

(0,0,0)

live_id

str

live control identifier

live_min

ivec3

minimum value allowed during live change (only honored when live_id is set)

(-100,-100,-100)

live_max

ivec3

maximum value allowed during live change (only honored when live_id is set)

(100,100,100)

Source: src/node_uniform.c

UniformIVec4ΒΆ

Parameter

Flags

Type

Description

Default

value

live

ivec4

value exposed to the shader

(0,0,0,0)

live_id

str

live control identifier

live_min

ivec4

minimum value allowed during live change (only honored when live_id is set)

(-100,-100,-100,-100)

live_max

ivec4

maximum value allowed during live change (only honored when live_id is set)

(100,100,100,100)

Source: src/node_uniform.c

UniformUIntΒΆ

Parameter

Flags

Type

Description

Default

value

live

u32

value exposed to the shader

0

live_id

str

live control identifier

live_min

u32

minimum value allowed during live change (only honored when live_id is set)

0

live_max

u32

maximum value allowed during live change (only honored when live_id is set)

100

Source: src/node_uniform.c

UniformUIVec2ΒΆ

Parameter

Flags

Type

Description

Default

value

live

uvec2

value exposed to the shader

(0,0)

live_id

str

live control identifier

live_min

uvec2

minimum value allowed during live change (only honored when live_id is set)

(0,0)

live_max

uvec2

maximum value allowed during live change (only honored when live_id is set)

(100,100)

Source: src/node_uniform.c

UniformUIVec3ΒΆ

Parameter

Flags

Type

Description

Default

value

live

uvec3

value exposed to the shader

(0,0,0)

live_id

str

live control identifier

live_min

uvec3

minimum value allowed during live change (only honored when live_id is set)

(0,0,0)

live_max

uvec3

maximum value allowed during live change (only honored when live_id is set)

(100,100,100)

Source: src/node_uniform.c

UniformUIVec4ΒΆ

Parameter

Flags

Type

Description

Default

value

live

uvec4

value exposed to the shader

(0,0,0,0)

live_id

str

live control identifier

live_min

uvec4

minimum value allowed during live change (only honored when live_id is set)

(0,0,0,0)

live_max

uvec4

maximum value allowed during live change (only honored when live_id is set)

(100,100,100,100)

Source: src/node_uniform.c

UniformMat4ΒΆ

Parameter

Flags

Type

Description

Default

value

live

mat4

value exposed to the shader

(1,0,0,0 0,1,0,0 0,0,1,0 0,0,0,1)

live_id

str

live control identifier

transform

node (Rotate, RotateQuat, Transform, Translate, Scale, Skew, Identity)

value transformation chain

Source: src/node_uniform.c

UniformFloatΒΆ

Parameter

Flags

Type

Description

Default

value

live

f32

value exposed to the shader

0

live_id

str

live control identifier

live_min

f32

minimum value allowed during live change (only honored when live_id is set)

0

live_max

f32

maximum value allowed during live change (only honored when live_id is set)

1

Source: src/node_uniform.c

UniformVec2ΒΆ

Parameter

Flags

Type

Description

Default

value

live

vec2

value exposed to the shader

(0,0)

live_id

str

live control identifier

live_min

vec2

minimum value allowed during live change (only honored when live_id is set)

(0,0)

live_max

vec2

maximum value allowed during live change (only honored when live_id is set)

(1,1)

Source: src/node_uniform.c

UniformVec3ΒΆ

Parameter

Flags

Type

Description

Default

value

live

vec3

value exposed to the shader

(0,0,0)

live_id

str

live control identifier

live_min

vec3

minimum value allowed during live change (only honored when live_id is set)

(0,0,0)

live_max

vec3

maximum value allowed during live change (only honored when live_id is set)

(1,1,1)

Source: src/node_uniform.c

UniformVec4ΒΆ

Parameter

Flags

Type

Description

Default

value

live

vec4

value exposed to the shader

(0,0,0,0)

live_id

str

live control identifier

live_min

vec4

minimum value allowed during live change (only honored when live_id is set)

(0,0,0,0)

live_max

vec4

maximum value allowed during live change (only honored when live_id is set)

(1,1,1,1)

Source: src/node_uniform.c

UniformColorΒΆ

Parameter

Flags

Type

Description

Default

value

live

vec3

value exposed to the shader

(0,0,0)

live_id

str

live control identifier

live_min

vec3

minimum value allowed during live change (only honored when live_id is set)

(0,0,0)

live_max

vec3

maximum value allowed during live change (only honored when live_id is set)

(1,1,1)

space

colorspace

color space defining how to interpret value

srgb

Source: src/node_uniform.c

UniformQuatΒΆ

Parameter

Flags

Type

Description

Default

value

live

vec4

value exposed to the shader

(0,0,0,1)

live_id

str

live control identifier

live_min

vec4

minimum value allowed during live change (only honored when live_id is set)

(-1,-1,-1,-1)

live_max

vec4

maximum value allowed during live change (only honored when live_id is set)

(1,1,1,1)

as_mat4

bool

exposed as a 4x4 rotation matrix in the program

0

Source: src/node_uniform.c

UserSelectΒΆ

Parameter

Flags

Type

Description

Default

branches

node_list

a set of branches to pick from

branch

live

i32

controls which branch is taken

0

live_id

str

live control identifier

live_min

i32

minimum value allowed during live change (only honored when live_id is set)

0

live_max

i32

maximum value allowed during live change (only_honored when live_id is set)

10

Source: src/node_userselect.c

UserSwitchΒΆ

Parameter

Flags

Type

Description

Default

child

nonull

node

scene to be rendered or not

enabled

live

bool

set if the scene should be rendered

1

live_id

str

live control identifier

Source: src/node_userswitch.c

VelocityFloatΒΆ

Parameter

Flags

Type

Description

Default

animation

nonull

node (AnimatedFloat)

1D animation to analyze the velocity from

Source: src/node_velocity.c

VelocityVec2ΒΆ

Parameter

Flags

Type

Description

Default

animation

nonull

node (AnimatedVec2)

2D animation to analyze the velocity from

Source: src/node_velocity.c

VelocityVec3ΒΆ

Parameter

Flags

Type

Description

Default

animation

nonull

node (AnimatedVec3)

3D animation to analyze the velocity from

Source: src/node_velocity.c

VelocityVec4ΒΆ

Parameter

Flags

Type

Description

Default

animation

nonull

node (AnimatedVec4)

4D animation to analyze the velocity from

Source: src/node_velocity.c

Parameter typesΒΆ

Type

Description

i32

32-bit integer

ivec2

2 32-bit integers

ivec3

3 32-bit integers

ivec4

4 32-bit integers

bool

Boolean (map to int in C)

u32

32-bit unsigned integer

uvec2

2 32-bit unsigned integers

uvec3

3 32-bit unsigned integers

uvec4

4 32-bit unsigned integers

f64

64-bit float

str

String

data

Agnostic data buffer

f32

32-bit float

vec2

2 32-bit floats

vec3

3 32-bit floats

vec4

4 32-bit floats

mat4

4x4 32-bit floats, column major memory layout (the first 4 floats corresponds to 1 mathematical matrix column)

node

nope.gl Node

node_list

List of nope.gl Node

f64_list

List of 64-bit floats

node_dict

Dictionary mapping arbitrary string identifiers to nope.gl Nodes

select

Selection of one constant (expressed as a string)

flags

Combination of constants (expressed as strings), using + as separator. Can be empty for none.

rational

Rational number (expressed as 2 32-bit integers, respectively as numerator and denominator)

Parameter flagsΒΆ

Marker

Meaning

live

value is live-changeable between draw calls

node

nodes with the same data size are also allowed (e.g a vec3 parameter can accept AnimatedVec3, EvalVec3, NoiseVec3, …)

nonull

parameter must be set

Constants for choices parametersΒΆ

colorspace choicesΒΆ

Constant

Description

srgb

sRGB (standard RGB)

hsl

Hue/Saturation/Lightness (polar form of sRGB)

hsv

Hue/Saturation/Value (polar form of sRGB)

easing choicesΒΆ

Constant

Description

linear

linear(x)=x

quadratic_in

quadratic(x)=xΒ²

quadratic_out

quadratic_out(x)=1-quadratic(1-x)

quadratic_in_out

quadratic_in_out(x)=quadratic(2x)/2 if x<Β½ else 1-quadratic(2*(1-x))/2

quadratic_out_in

quadratic_out_in(x)=(1-quadratic(1-2x))/2 if x<Β½ else (1+quadratic(2x-1))/2

cubic_in

cubic(x)=xΒ³

cubic_out

cubic_out(x)=1-cubic(1-x)

cubic_in_out

cubic_in_out(x)=cubic(2x)/2 if x<Β½ else 1-cubic(2*(1-x))/2

cubic_out_in

cubic_out_in(x)=(1-cubic(1-2x))/2 if x<Β½ else (1+cubic(2x-1))/2

quartic_in

quartic(x)=x⁴

quartic_out

quartic_out(x)=1-quartic(1-x)

quartic_in_out

quartic_in_out(x)=quartic(2x)/2 if x<Β½ else 1-quartic(2*(1-x))/2

quartic_out_in

quartic_out_in(x)=(1-quartic(1-2x))/2 if x<Β½ else (1+quartic(2x-1))/2

quintic_in

quintic(x)=x⁡

quintic_out

quintic_out(x)=1-quintic(1-x)

quintic_in_out

quintic_in_out(x)=quintic(2x)/2 if x<Β½ else 1-quintic(2*(1-x))/2

quintic_out_in

quintic_out_in(x)=(1-quintic(1-2x))/2 if x<Β½ else (1+quintic(2x-1))/2

power_in

power(x,a=1)=x^a

power_out

power_out(x,a=1)=1-power(1-x,a)

power_in_out

power_in_out(x,a=1)=power(2x,a)/2 if x<Β½ else 1-power(2*(1-x),a)/2

power_out_in

power_out_in(x,a=1)=(1-power(1-2x,a))/2 if x<Β½ else (1+power(2x-1,a))/2

sinus_in

sinus(x)=1-cos(x*Ο€/2)

sinus_out

sinus_out(x)=1-sinus(1-x)

sinus_in_out

sinus_in_out(x)=sinus(2x)/2 if x<Β½ else 1-sinus(2*(1-x))/2

sinus_out_in

sinus_out_in(x)=(1-sinus(1-2x))/2 if x<Β½ else (1+sinus(2x-1))/2

exp_in

exp(x,a=1024)=(pow(a,x)-1)/(a-1)

exp_out

exp_out(x,a=1024)=1-exp(1-x,a)

exp_in_out

exp_in_out(x,a=1024)=exp(2x,a)/2 if x<Β½ else 1-exp(2*(1-x),a)/2

exp_out_in

exp_out_in(x,a=1024)=(1-exp(1-2x,a))/2 if x<Β½ else (1+exp(2x-1,a))/2

circular_in

circular(x)=1-√(1-x²)

circular_out

circular_out(x)=1-circular(1-x)

circular_in_out

circular_in_out(x)=circular(2x)/2 if x<Β½ else 1-circular(2*(1-x))/2

circular_out_in

circular_out_in(x)=(1-circular(1-2x))/2 if x<Β½ else (1+circular(2x-1))/2

bounce_in

bouncing from right to left 4 times

bounce_out

diagonally mirrored version of bounce_in()

elastic_in

elastic effect from weak to strong

elastic_out

mirrored elastic_in effect

back_in

mirrored back_out effect

back_out

overstep target value and smoothly converge back to it

back_in_out

combination of back_in then back_out

back_out_in

combination of back_out then back_in

memory_layout choicesΒΆ

Constant

Description

std140

standard uniform block memory layout 140

std430

standard uniform block memory layout 430

selector_component choicesΒΆ

Constant

Description

lightness

lightness component from OkLCH (within [0,1])

chroma

chroma component from OkLCH (infinite upper boundary, but in practice within [0,0.4])

hue

hue component from OkLCH (circular value in radian)

selector_drop choicesΒΆ

Constant

Description

outside

drop if value is outside the range

inside

drop if value is inside the range

selector_output choicesΒΆ

Constant

Description

colorholes

replace the selected colors with (0,0,0,0)

binary

same as colorholes but non-selected colors become (1,1,1,1)

topology choicesΒΆ

Constant

Description

point_list

point list

line_strip

line strip

line_list

line list

triangle_strip

triangle strip

triangle_list

triangle list

blend_factor choicesΒΆ

Constant

Description

unset

unset

zero

0

one

1

src_color

src_color

one_minus_src_color

1 - src_color

dst_color

dst_color

one_minus_dst_color

1 - dst_color

src_alpha

src_alpha

one_minus_src_alpha

1 - src_alpha

dst_alpha

dst_alpha

one_minus_dst_alpha

1 - dst_alpha

blend_operation choicesΒΆ

Constant

Description

unset

unset

add

src + dst

sub

src - dst

revsub

dst - src

min

min(src, dst)

max

max(src, dst)

component choicesΒΆ

Constant

Description

r

red

g

green

b

blue

a

alpha

function choicesΒΆ

Constant

Description

unset

unset

never

f(a,b) = 0

less

f(a,b) = a < b

equal

f(a,b) = a == b

lequal

f(a,b) = a ≀ b

greater

f(a,b) = a > b

notequal

f(a,b) = a β‰  b

gequal

f(a,b) = a β‰₯ b

always

f(a,b) = 1

stencil_operation choicesΒΆ

Constant

Description

unset

unset

keep

keeps the current value

zero

sets the stencil buffer value to 0

replace

sets the stencil buffer value to ref, as specified by the stencil function

incr

increments the current stencil buffer value and clamps it

incr_wrap

increments the current stencil buffer value and wraps it

decr

decrements the current stencil buffer value and clamps it

decr_wrap

decrements the current stencil buffer value and wraps it

decr_invert

bitwise inverts the current stencil buffer value

cull_mode choicesΒΆ

Constant

Description

unset

unset

none

no facets are discarded

front

cull front-facing facets

back

cull back-facing facets

precision choicesΒΆ

Constant

Description

auto

automatic

high

high

medium

medium

low

low

nopemd_log_level choicesΒΆ

Constant

Description

verbose

verbose messages

debug

debugging messages

info

informational messages

warning

warning messages

error

error messages

nopemd_hwaccel choicesΒΆ

Constant

Description

disabled

disable hardware acceleration

auto

enable hardware acceleration if available

interp_noise choicesΒΆ

Constant

Description

linear

linear interpolation (not recommended), f(t)=t

cubic

cubic hermite curve, f(t)=3tΒ²-2tΒ³

quintic

quintic curve, f(t)=6t⁡-15t⁴+10t³

blend_preset choicesΒΆ

Constant

Description

default

unchanged current graphics state

src_over

this node over destination

dst_over

destination over this node

src_out

subtract destination from this node

dst_out

subtract this node from destination

src_in

keep only the part of this node overlapping with destination

dst_in

keep only the part of destination overlapping with this node

src_atop

union of src_in and dst_out

dst_atop

union of src_out and dst_in

xor

exclusive or between this node and the destination

gradient_mode choicesΒΆ

Constant

Description

ramp

straight line gradient, uniform perpendicularly to the line between the points

radial

distance between the points spread circularly

scope_mode choicesΒΆ

Constant

Description

mixed

R, G and B channels overlap on each others

parade

split R, G and B channels

luma_only

only the luma channel

noise_type choicesΒΆ

Constant

Description

blocky

blocky noise

perlin

perlin noise

scale_mode choicesΒΆ

Constant

Description

auto

automatic size by fitting the specified bounding box

fixed

fixed character size (bounding box ignored for scaling)

valign choicesΒΆ

Constant

Description

center

vertically centered

bottom

bottom positioned

top

top positioned

halign choicesΒΆ

Constant

Description

center

horizontally centered

right

right positioned

left

left positioned

writing_mode choicesΒΆ

Constant

Description

horizontal-tb

left-to-right flow then top-to-bottom per line

vertical-rl

top-to-bottom flow then right-to-left per line

vertical-lr

top-to-bottom flow then left-to-right per line

text_target choicesΒΆ

Constant

Description

char

characters

char_nospace

characters (skipping whitespaces)

word

words

line

lines

text

whole text

format choicesΒΆ

Constant

Description

undefined

undefined

r8_unorm

8-bit unsigned normalized R component

r8_snorm

8-bit signed normalized R component

r8_uint

8-bit unsigned integer R component

r8_sint

8-bit signed integer R component

r8g8_unorm

8-bit unsigned normalized RG components

r8g8_snorm

8-bit signed normalized RG components

r8g8_uint

8-bit unsigned integer RG components

r8g8_sint

8-bit signed normalized RG components

r8g8b8a8_unorm

8-bit unsigned normalized RGBA components

r8g8b8a8_snorm

8-bit signed normalized RGBA components

r8g8b8a8_uint

8-bit unsigned integer RGBA components

r8g8b8a8_sint

8-bit signed integer RGBA components

r8g8b8a8_srgb

8-bit unsigned normalized RGBA components

b8g8r8a8_unorm

8-bit unsigned normalized BGRA components

b8g8r8a8_snorm

8-bit signed normalized BGRA components

b8g8r8a8_uint

8-bit unsigned integer BGRA components

b8g8r8a8_sint

8-bit signed integer BGRA components

r16_unorm

16-bit unsigned normalized R component

r16_snorm

16-bit signed normalized R component

r16_uint

16-bit unsigned integer R component

r16_sint

16-bit signed integer R component

r16_sfloat

16-bit signed float R component

r16g16_unorm

16-bit unsigned normalized RG components

r16g16_snorm

16-bit signed normalized RG components

r16g16_uint

16-bit unsigned integer RG components

r16g16_sint

16-bit signed integer RG components

r16g16_sfloat

16-bit signed float RG components

r16g16b16a16_unorm

16-bit unsigned normalized RGBA components

r16g16b16a16_snorm

16-bit signed normalized RGBA components

r16g16b16a16_uint

16-bit unsigned integer RGBA components

r16g16b16a16_sint

16-bit signed integer RGBA components

r16g16b16a16_sfloat

16-bit signed float RGBA components

r32_uint

32-bit unsigned integer R component

r32_sint

32-bit signed integer R component

r32_sfloat

32-bit signed float R component

r32g32_uint

32-bit unsigned integer RG components

r32g32_sint

32-bit signed integer RG components

r32g32_sfloat

32-bit signed float RG components

r32g32b32a32_uint

32-bit unsigned integer RGBA components

r32g32b32a32_sint

32-bit signed integer RGBA components

r32g32b32a32_sfloat

32-bit signed float RGBA components

d16_unorm

16-bit unsigned normalized depth component

d24_unorm

32-bit packed format that has 24-bit unsigned normalized depth component + 8-bit of unused data

d32_sfloat

32-bit signed float depth component

d24_unorm_s8_uint

32-bit packed format that has 24-bit unsigned normalized depth component + 8-bit unsigned integer stencil component

d32_sfloat_s8_uint

64-bit packed format that has 32-bit signed float depth component + 8-bit unsigned integer stencil component + 24-bit of unused data

s8_uint

8-bit unsigned integer stencil component

auto_depth

select automatically the preferred depth format

auto_depth_stencil

select automatically the preferred depth + stencil format

filter choicesΒΆ

Constant

Description

nearest

nearest filtering

linear

linear filtering

mipmap_filter choicesΒΆ

Constant

Description

none

no mipmap generation

nearest

nearest filtering

linear

linear filtering

wrap choicesΒΆ

Constant

Description

clamp_to_edge

clamp to edge wrapping

mirrored_repeat

mirrored repeat wrapping

repeat

repeat pattern wrapping