PXC Documentation

PXC Home

Canvas

1.18.0

Draw on surface using brush, eraser, etc.



Node Data

Display name

Canvas

Internal name

Node_Canvas

Inheritances

Node_Canvas

Inputs

Node_Canvas

dimension

Dimension

enum

Output Type

bool

Auto Frame

int

Frame Index

float

Animation Speed

enum

On End

bool

Render Background

enum

Background Type

color

Background Color

surface

Background

bool

Use Background Dimension

slider

Background Alpha

enum

Brush Type

surface

Brush Surface

range

Brush Distance

rotation_random

Random Direction

bool

Rotate By Direction

bool

Animated Brush

enum

Animation Type

float

Base Speed

float

Velocity Speed

float

Step Speed

enum

On Animation End

bool

Scatter

float

Scatter Amount

float

Scatter Radius

surface

Data Source

bool

Transfer Dimension

Outputs

Node_Canvas

surface

Surface Out

Attributes

Color Depth

Canvas node is used for drawing directly to surface.



Properties


Dimension


The size of the canvas.


Frames Animation


Whether to output as animated surface or surface array.


Animation Type


What to do when the animation reaches the last frame.



Animation Speed


The speed of the animation.


Background


The background texture.


Use Background Dimension


Whether to use the background texture dimensions instead of the Dimension.


Background Alpha


The alpha of the background texture.


Tools


Canvas node comes with a set of tools for drawing on the surface.


Actions


Actions are refered to the right-side button in the preview panel. These can be seen as tools for more specific tasks.