Interfaces

VerticesProps

Paint attributes shared by every drawing component, <Group>, and <Paint>.

Extends

Properties

antiAlias?

optional antiAlias?: boolean;

Inherited from

PaintProps.antiAlias


blendMode?

optional blendMode?: BlendMode;

How this drawing composites onto what is already there. 'srcOver' by default.

Inherited from

PaintProps.blendMode


buffer?

optional buffer?: object;

A shared mesh buffer from useVertexBuffer: positions (and reserved texture/colour/index sections) written in place and read at draw - the zero-allocation path for per-frame mesh deformation. Replaces the inline arrays below when given.

hasColors

hasColors: boolean;

hasTextures

hasTextures: boolean;

id

id: number;

maxIndices

maxIndices: number;

maxVertices

maxVertices: number;

children?

optional children?: ReactNode;

Inherited from

PaintProps.children


color?

optional color?: Animated<Color>;

Inherited from

PaintProps.color


colors?

optional colors?: Color[];

One colour per vertex, interpolated across each triangle.


indexCount?

optional indexCount?: Animated<number>;

How many buffer indices to draw. A value slot; defaults to the capacity.


indices?

optional indices?: number[];

Indices into vertices. Without them the vertices are taken in order. Indexed meshes are capped at 65536 vertices, and every index must be in range - one that is not skips the whole mesh.


mode?

optional mode?: MeshTopology;

Defaults to 'triangles'.


opacity?

optional opacity?: Animated<number>;

Paint-wide alpha multiplier in [0, 1]; only one per chain can animate.

Inherited from

PaintProps.opacity


ref?

optional ref?: NodeHandle;

A handle from useNode(), for changing this node without a React render. See NodeHandle.

Inherited from

PaintProps.ref


strokeCap?

optional strokeCap?: "butt" | "round" | "square";

Inherited from

PaintProps.strokeCap


strokeJoin?

optional strokeJoin?: "round" | "miter" | "bevel";

Inherited from

PaintProps.strokeJoin


strokeMiter?

optional strokeMiter?: Animated<number>;

Past this length-over-width ratio a 'miter' join falls back to bevel. Defaults to 4.

Inherited from

PaintProps.strokeMiter


strokeWidth?

optional strokeWidth?: Animated<number>;

Inherited from

PaintProps.strokeWidth


style?

optional style?: "fill" | "stroke";

'fill' (default) or 'stroke'.

Inherited from

PaintProps.style


textures?

optional textures?: Vector[];

One texture coordinate per vertex, in the pixels of the image behind an <ImageShader> on this node's paint. Without a shader they do nothing.


vertexCount?

optional vertexCount?: Animated<number>;

How many buffer vertices to draw. A value slot; defaults to the capacity.


vertices?

optional vertices?: Vector[];

Vertex positions, in canvas points.


visible?

optional visible?: Animated<number | boolean>;

Skip drawing (and hit-testing) this node. A value slot, so a handle or a SharedValue toggles it with no re-encode - the supported way to pool mounted nodes for particle systems and variable-count scenes.

Inherited from

PaintProps.visible