Interfaces

CameraFrameProps

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


children?

optional children?: ReactNode;

Inherited from

PaintProps.children


color?

optional color?: Animated<Color>;

Inherited from

PaintProps.color


fit?

optional fit?: Fit;

How the frame is scaled into the canvas. Defaults to 'cover', which fills the canvas and lets the overflowing axis run off it.


image

image: ImageLike | null;

A hardware-buffer handle from imageFromNativeBuffer, re-pointed at each new frame with image.setNativeBuffer(...). null draws nothing at all, children included - there is no frame to place them against.


mirror?

optional mirror?: boolean;

Flip the buffer horizontally. Pass frame.isMirrored straight through.


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


rotation?

optional rotation?: number;

Clockwise degrees to rotate the buffer by so it is the right way up. This counters frame.orientation: a frame reporting 'right' (pixels rotated +90° from upright) needs 270.

Rounded to the nearest quarter turn and wrapped, so -90 and 270 are the same thing - a detector or camera API that reports signed degrees can be passed straight through.


sampling?

optional sampling?: Sampling;

Defaults to 'linear'.


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


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