unreal.SharedImageConstRefBlueprintFns

class unreal.SharedImageConstRefBlueprintFns(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Shared Image Const Ref Blueprint Fns

C++ Source:

  • Module: ImageCore

  • File: ImageCoreBP.h

classmethod get_height(image) → int32

Returns -1 if Image is invalid

Parameters:

image (SharedImageConstRefBlueprint) –

Return type:

int32

classmethod get_pixel_linear_color(image, x, y, failure_color=[0.000000, 0.000000, 0.000000, 1.000000]) -> (LinearColor, valid=bool)

Returns the color value for the given pixel. If the input position is invalid, the format is invalid, or the reference isn’t set, bValid will be false and the function will return FailureColor. The color is converted using the image’s gamma space in to linear space.

Do not use this for full image processing as it will be extremely slow, contact support if you need such functionality.

Parameters:
Returns:

valid (bool):

Return type:

bool

classmethod get_pixel_value(image, x, y) -> (Vector4f, valid=bool)

Returns the value in the texture for the given pixel as a float vector. If the input position is invalid, the format is invalid, or the reference isn’t set, bValid will be false and the function will return FVector4(0,0,0,0).

Pixel values are directly returned with no gamma transformation to allow for lookup tables. Also note that 8 bit formats that you might normally expect to be normalized to 0..1 will return their values directly as 0..256.

This supports all image formats.

G8 is replicated to X/Y/Z/1. R16/R32 is returned as R/0/0/1.

Do not use this for full image processing as it will be extremely slow, contact support if you need such functionality.

Parameters:
Returns:

valid (bool):

Return type:

bool

classmethod get_size(image) → Vector2f

Returns (-1, -1) if Image is invalid

Parameters:

image (SharedImageConstRefBlueprint) –

Return type:

Vector2f

classmethod get_width(image) → int32

Returns -1 if Image is invalid

Parameters:

image (SharedImageConstRefBlueprint) –

Return type:

int32

classmethod is_valid(image) → bool

Is Valid

Parameters:

image (SharedImageConstRefBlueprint) –

Return type:

bool