CreateNodeImageProgramOptions

Defined in: packages/node-image/src/types.ts:79

Full options for creating a node image program.

Extends

TextureManagerOptions

Properties

backgroundLayerFactory

backgroundLayerFactory: () => FragmentLayer

Defined in: packages/node-image/src/types.ts:98

A function that generates the layer to put “behind” the image layer:

Returns

FragmentLayer

Default

layerFill

colorAttribute

colorAttribute: string

Defined in: packages/node-image/src/types.ts:112

Name of the node attribute to read the color from. Used in “color” drawing mode to colorize image pixels.

Default

"color"

correctCentering

correctCentering: boolean

Defined in: packages/node-image/src/texture.ts:32

Inherited from

TextureManagerOptions.correctCentering

crossOrigin

crossOrigin: CrossOrigin | null

Defined in: packages/node-image/src/texture.ts:41

Inherited from

TextureManagerOptions.crossOrigin

debounceTimeout

debounceTimeout: number | null

Defined in: packages/node-image/src/texture.ts:37

Inherited from

TextureManagerOptions.debounceTimeout

drawingMode

drawingMode: DrawingMode

Defined in: packages/node-image/src/types.ts:86

Drawing mode:

“image”: Image is rendered as-is (transparent pixels show through)
“color”: Image pixels are colorized with the node color (for pictograms)

Default

"image"

imageAttribute

imageAttribute: string

Defined in: packages/node-image/src/types.ts:118

Name of the node attribute to read the image URL from.

Default

"image"

maxTextureSize

maxTextureSize: number

Defined in: packages/node-image/src/texture.ts:34

Inherited from

TextureManagerOptions.maxTextureSize

objectFit

objectFit: "contain" | "cover" | "fill"

Defined in: packages/node-image/src/texture.ts:30

Inherited from

TextureManagerOptions.objectFit

padding

padding: number

Defined in: packages/node-image/src/types.ts:105

Padding around the image, expressed as a [0, 1] percentage. A padding of 0.05 will always be 5% of the diameter of the node.

Default

shapeFactory

shapeFactory: () => SDFShape

Defined in: packages/node-image/src/types.ts:92

A function that generates an SDF shape

Returns

SDFShape

Default

sdfCircle

size

size: { mode: "auto"; } | { mode: "max"; value: number; } | { mode: "force"; value: number; }

Defined in: packages/node-image/src/texture.ts:28

Inherited from

TextureManagerOptions.size