unreal.MediaTexture

class unreal.MediaTexture(outer=None, name='None')

Bases: unreal.Texture

Implements a texture asset for rendering video tracks from UMediaPlayer assets.

C++ Source:

  • Module: MediaAssets

  • File: MediaTexture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • address_x (TextureAddress): [Read-Write] Address X: The addressing mode to use for the X axis.

  • address_y (TextureAddress): [Read-Write] Address Y: The addressing mode to use for the Y axis.

  • adjust_brightness (float): [Read-Write] Adjust Brightness: Static texture brightness adjustment (scales HSV value.) (Non-destructive; Requires texture source art to be available.)

  • adjust_brightness_curve (float): [Read-Write] Adjust Brightness Curve: Static texture curve adjustment (raises HSV value to the specified power.) (Non-destructive; Requires texture source art to be available.)

  • adjust_hue (float): [Read-Write] Adjust Hue: Static texture hue adjustment (0 - 360) (offsets HSV hue by value in degrees.) (Non-destructive; Requires texture source art to be available.)

  • adjust_max_alpha (float): [Read-Write] Adjust Max Alpha: Remaps the alpha to the specified min/max range, defines the new value of 1 (Non-destructive; Requires texture source art to be available.)

  • adjust_min_alpha (float): [Read-Write] Adjust Min Alpha: Remaps the alpha to the specified min/max range, defines the new value of 0 (Non-destructive; Requires texture source art to be available.)

  • adjust_rgb_curve (float): [Read-Write] Adjust RGBCurve: Static texture RGB curve adjustment (raises linear-space RGB color to the specified power.) (Non-destructive; Requires texture source art to be available.)

  • adjust_saturation (float): [Read-Write] Adjust Saturation: Static texture saturation adjustment (scales HSV saturation.) (Non-destructive; Requires texture source art to be available.)

  • adjust_vibrance (float): [Read-Write] Adjust Vibrance: Static texture “vibrance” adjustment (0 - 1) (HSV saturation algorithm adjustment.) (Non-destructive; Requires texture source art to be available.)

  • alpha_coverage_thresholds (Vector4): [Read-Write] Alpha Coverage Thresholds: Alpha values per channel to compare to when preserving alpha coverage. 0 means disable channel. Typical good values in 0.5 - 0.9, not 1.0

  • asset_import_data (AssetImportData): [Read-Only] Asset Import Data

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the asset

  • auto_clear (bool): [Read-Write] Auto Clear: Whether to clear the texture when no media is being played (default = enabled).

  • chroma_key_color (Color): [Read-Write] Chroma Key Color: The color that will be replaced with transparent black if chroma keying is enabled

  • chroma_key_texture (bool): [Read-Write] Chroma Key Texture: Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black

  • chroma_key_threshold (float): [Read-Write] Chroma Key Threshold: The threshold that components have to match for the texel to be considered equal to the ChromaKeyColor when chroma keying (<=, set to 0 to require a perfect exact match)

  • clear_color (LinearColor): [Read-Write] Clear Color: The color used to clear the texture if AutoClear is enabled (default = black).

  • composite_power (float): [Read-Write] Composite Power: default 1, high values result in a stronger effect e.g 1, 2, 4, 8 this is no slider because the texture update would not be fast enough

  • composite_texture (Texture): [Read-Write] Composite Texture: Can be defined to modify the roughness based on the normal map variation (mostly from mip maps). MaxAlpha comes in handy to define a base roughness if no source alpha was there. Make sure the normal map has at least as many mips as this texture.

  • composite_texture_mode (CompositeTextureMode): [Read-Write] Composite Texture Mode: defines how the CompositeTexture is applied, e.g. CTM_RoughnessFromNormalAlpha

  • compression_no_alpha (bool): [Read-Write] Compression No Alpha: If enabled, the texture’s alpha channel will be discarded during compression

  • compression_quality (TextureCompressionQuality): [Read-Write] Compression Quality: The compression quality for generated ASTC textures (i.e. mobile platform textures).

  • compression_settings (TextureCompressionSettings): [Read-Write] Compression Settings: Compression settings to use when building the texture.

  • current_aspect_ratio (float): [Read-Write] Current Aspect Ratio: Current aspect ratio

  • current_orientation (MediaTextureOrientation): [Read-Write] Current Orientation: Current media orientation

  • defer_compression (bool): [Read-Write] Defer Compression: If enabled, defer compression of the texture until save or manually compressed in the texture editor.

  • dither_mip_map_alpha (bool): [Read-Write] Dither Mip Map Alpha: When true, the alpha channel of mip-maps and the base image are dithered for smooth LOD transitions.

  • do_scale_mips_for_alpha_coverage (bool): [Read-Write] Do Scale Mips for Alpha Coverage: Whether mip RGBA should be scaled to preserve the number of pixels with Value >= AlphaCoverageThresholds. AlphaCoverageThresholds are ignored if this is off.

  • downscale (PerPlatformFloat): [Read-Write] Downscale: Downscale source texture, applied only to textures without mips 0.0 - use scale value from texture group 1.0 - do not scale texture > 1.0 - scale texure

  • downscale_options (TextureDownscaleOptions): [Read-Write] Downscale Options: Texture downscaling options

  • enable_gen_mips (bool): [Read-Write] Enable Gen Mips: Basic enablement for mip generation (default = false).

  • filter (TextureFilter): [Read-Write] Filter: The texture filtering mode to use when sampling this texture.

  • flip_green_channel (bool): [Read-Write] Flip Green Channel: When true the texture’s green channel will be inverted. This is useful for some normal maps.

  • global_force_mip_levels_to_be_resident (bool): [Read-Write] Global Force Mip Levels to be Resident: Global and serialized version of ForceMiplevelsToBeResident.

  • lod_bias (int32): [Read-Write] LODBias: A bias to the index of the top mip level to use.

  • lod_group (TextureGroup): [Read-Write] LODGroup: Texture group this texture belongs to

  • lossy_compression_amount (TextureLossyCompressionAmount): [Read-Write] Lossy Compression Amount: How aggressively should any relevant lossy compression be applied. For compressors that support EncodeSpeed (i.e. Oodle), this is only

    applied if enabled (see Project Settings -> Texture Encoding). Note that this is in addition to any unavoidable loss due to the target format - selecting “No Lossy Compression” will not result in zero distortion for BCn formats.

  • max_texture_size (int32): [Read-Write] Max Texture Size: The maximum resolution for generated textures. A value of 0 means the maximum size for the format on each platform.

  • media_player (MediaPlayer): [Read-Write] Media Player: The media player asset associated with this texture.

    This property is meant for design-time convenience. To change the associated media player at run-time, use the SetMediaPlayer method. see: SetMediaPlayer

  • mip_gen_settings (TextureMipGenSettings): [Read-Write] Mip Gen Settings: Per asset specific setting to define the mip-map generation properties like sharpening and kernel size.

  • mip_load_options (TextureMipLoadOptions): [Read-Write] Mip Load Options: The texture mip load options.

  • never_stream (bool): [Read-Write] Never Stream

  • new_style_output (bool): [Read-Write] New Style Output: Enable new style output (default = false).

  • num_cinematic_mip_levels (int32): [Read-Write] Num Cinematic Mip Levels: Number of mip-levels to use for cinematic quality.

  • num_mips (uint8): [Read-Write] Num Mips: The number of mips to use (default = 1).

  • oodle_texture_sdk_version (Name): [Read-Write] Oodle Texture Sdk Version: Oodle Texture SDK Version to encode with. Enter ‘latest’ to update; ‘None’ preserves legacy encoding to avoid patches.

  • output_format (MediaTextureOutputFormat): [Read-Write] Output Format

  • padding_color (Color): [Read-Write] Padding Color: The color used to pad the texture out if it is resized due to PowerOfTwoMode

  • power_of_two_mode (TexturePowerOfTwoSetting): [Read-Write] Power Of Two Mode: How to pad the texture to a power of 2 size (if necessary)

  • preserve_border (bool): [Read-Write] Preserve Border: When true the texture’s border will be preserved during mipmap generation.

  • source_color_settings (TextureSourceColorSettings): [Read-Write] Source Color Settings: Texture color management settings: source encoding and color space.

  • srgb (bool): [Read-Write] SRGB: This should be unchecked if using alpha channels individually as masks.

  • use_legacy_gamma (bool): [Read-Write] Use Legacy Gamma: A flag for using the simplified legacy gamma space e.g pow(color,1/2.2) for converting from FColor to FLinearColor, if we’re doing sRGB.

  • virtual_texture_streaming (bool): [Read-Write] Virtual Texture Streaming: Is this texture streamed in using VT

property address_x

[Read-Write] Address X: The addressing mode to use for the X axis.

Type

(TextureAddress)

property address_y

[Read-Write] Address Y: The addressing mode to use for the Y axis.

Type

(TextureAddress)

property auto_clear

[Read-Write] Auto Clear: Whether to clear the texture when no media is being played (default = enabled).

Type

(bool)

property clear_color

[Read-Write] Clear Color: The color used to clear the texture if AutoClear is enabled (default = black).

Type

(LinearColor)

property current_aspect_ratio

[Read-Only] Current Aspect Ratio: Current aspect ratio

Type

(float)

property current_orientation

[Read-Only] Current Orientation: Current media orientation

Type

(MediaTextureOrientation)

property enable_gen_mips

[Read-Only] Enable Gen Mips: Basic enablement for mip generation (default = false).

Type

(bool)

get_aspect_ratio() → float

Gets the current aspect ratio of the texture. see: GetHeight, GetWidth

Returns

Texture aspect ratio.

Return type

float

get_height() → int32

Gets the current height of the texture. see: GetAspectRatio, GetWidth

Returns

Texture height (in pixels).

Return type

int32

get_media_player() → MediaPlayer

Get the media player that provides the video samples. see: SetMediaPlayer

Returns

The texture’s media player, or nullptr if not set.

Return type

MediaPlayer

get_texture_num_mips() → int32

Gets the current numbe of mips of the texture.

Returns

Number of mips.

Return type

int32

get_width() → int32

Gets the current width of the texture. see: GetAspectRatio, GetHeight

Returns

Texture width (in pixels).

Return type

int32

property new_style_output

[Read-Write] New Style Output: Enable new style output (default = false).

Type

(bool)

property num_mips

[Read-Write] Num Mips: The number of mips to use (default = 1).

Type

(uint8)

property output_format

[Read-Write] Output Format

Type

(MediaTextureOutputFormat)

set_media_player(new_media_player) → None

Set the media player that provides the video samples. see: GetMediaPlayer

Parameters

new_media_player (MediaPlayer) – The player to set.

update_resource() → None

Creates a new resource for the texture, and updates any cached references to the resource. This obviously is just an override to expose to blueprints.