CompositorNodeRelativeToPixel(CompositorNode)

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeRelativeToPixel(CompositorNode)

Converts values that are relative to the image size to be in terms of pixels

data_type

The type of data (default 'FLOAT')

  • FLOAT Float – Float value.

  • VECTOR Vector – Vector value.

Type:

Literal[‘FLOAT’, ‘VECTOR’]

reference_dimension

Defines the dimension of the image that the relative value is in reference to (default 'X')

  • PER_DIMENSION Per Dimension – The value is relative to each of the dimensions of the image independently.

  • X X – The value is relative to the X dimension of the image.

  • Y Y – The value is relative to the Y dimension of the image.

  • Greater Greater – The value is relative to the greater dimension of the image.

  • Smaller Smaller – The value is relative to the smaller dimension of the image.

  • Diagonal Diagonal – The value is relative to the diagonal of the image.

Type:

Literal[‘PER_DIMENSION’, ‘X’, ‘Y’, ‘Greater’, ‘Smaller’, ‘Diagonal’]

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

bool

classmethod input_template(index)

Input socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)

Output socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions