FTextureBuildSettings

Texture build settings.

Windows
MacOS
Linux

References

Module

TextureCompressor

Header

/Engine/Source/Developer/TextureCompressor/Public/TextureCompressorModule.h

Include

#include "TextureCompressorModule.h"

Syntax

struct FTextureBuildSettings

Remarks

Texture build settings.

Variables

Name Description

Public variable

FVector4

 

AlphaCoverageThresholds

Channel values to compare to when preserving alpha coverage.

Public variable

int32

 

ArraySlices

The array texture's top mip size Z without LODBias applied

Public variable

uint32: 1

 

bApplyKernelToTopMip

1:apply mip sharpening/blurring kernel to top mip as well (at half the kernel size), 0:don't

Public variable

uint32: 1

 

bApplyYCoCgBlockScale

Calculate and apply a scale for YCoCg textures.

Public variable

uint32: 1

 

bBorderColorBlack

Whether the border color should be black.

Public variable

uint32: 1

 

bChromaKeyTexture

Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black

Public variable

uint32: 1

 

bComputeBokehAlpha

Whether bokeh alpha values should be computed for the texture.

Public variable

uint32: 1

 

bCubemap

Whether the texture being built is a cubemap.

Public variable

uint32: 1

 

bDitherMipMapAlpha

Whether the alpha channel should contain a dithered alpha value.

Public variable

uint32: 1

 

bDownsampleWithAverage

Whether each mip should use the downsampled-with-average result instead of the sharpened result.

Public variable

uint32: 1

 

bFlipGreenChannel

Whether the green channel should be flipped. Typically only done on normal maps.

Public variable

bool

 

bHDRSource

Whether the texture being built contains HDR source data

Public variable

uint32: 1

 

bLongLatSource

Whether the texture being built from long/lat source to cubemap.

Public variable

uint32: 1

 

bPreserveBorder

Whether the border of the image should be maintained during mipmap generation.

Public variable

uint32: 1

 

bRenormalizeTopMip

1: renormalizes the top mip (only useful for normal maps, prevents artists errors and adds quality) 0:don't

Public variable

uint32: 1

 

bReplicateAlpha

Whether the contents of the alpha channel should be replicated to all channels.

Public variable

uint32: 1

 

bReplicateRed

Whether the contents of the red channel should be replicated to all channels.

Public variable

uint32: 1

 

bSharpenWithoutColorShift

Whether sharpening should prevent color shifts.

Public variable

uint32: 1

 

bSRGB

Whether the texture contains color data in the sRGB colorspace.

Public variable

uint32: 1

 

bStreamable

Can the texture be streamed

Public variable

uint32: 1

 

bTextureArray

Whether the texture being built is a texture array.

Public variable

uint32: 1

 

bUseLegacyGamma

Whether the texture should use the legacy gamma space for converting to sRGB

Public variable

uint32: 1

 

bVirtualStreamable

Is the texture streamed using the VT system

Public variable

uint32: 1

 

bVirtualTextureEnableCompressCrunch

Is crunch compression enabled

Public variable

uint32: 1

 

bVirtualTextureEnableCompressZlib

Is zlib compression enabled

Public variable

uint32: 1

 

bVolume

Whether the texture being built is a volume.

Public variable

FColor

 

ChromaKeyColor

The color that will be replaced with transparent black if chroma keying is enabled

Public variable

float

 

ChromaKeyThreshold

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)

Public variable

FColorAdjustmen...

 

ColorAdjustment

Color adjustment parameters.

Public variable

float

 

CompositePower

Default 1, high values result in a stronger effect

Public variable

uint8

 

CompositeTextureMode

E.g. CTM_RoughnessFromNormalAlpha

Public variable

int32

 

CompressionQuality

The quality of the compression algorithm (min 0 - lowest quality, highest cook speed, 4 - highest quality, lowest cook speed)

Public variable

uint32

 

DiffuseConvolveMipLevel

For angular filtered cubemaps, the mip level which contains convolution with the diffuse cosine lobe.

Public variable

float

 

Downscale

Values > 1.0 will scale down source texture. Ignored for textures with mips

Public variable

uint8

 

DownscaleOptions

ETextureDownscaleOptions

Public variable

uint32

 

LODBias

The source texture's final LOD bias (i.e. includes LODGroup based biases)

Public variable

uint32

 

LODBiasWithCinematicMips

The source texture's final LOD bias (i.e. includes LODGroup based biases).

Public variable

int32

 

LossyCompressionAmount

ETextureLossyCompressionAmount

Public variable

uint32

 

MaxTextureResolution

For maximum resolution.

Public variable

uint8

 

MipGenSettings

Mipmap generation settings.

Public variable

float

 

MipSharpening

The desired amount of mip sharpening.

Public variable

FColor

 

PaddingColor

The color used to pad the texture out if it is resized due to PowerOfTwoMode

Public variable

uint8

 

PowerOfTwoMode

How to stretch or pad the texture to a power of 2 size (if necessary); ETexturePowerOfTwoSetting::Type, opaque to avoid dependencies on Engine headers.

Public variable

uint32

 

SharpenMipKernelSize

The size of the kernel with which mips should be sharpened.

Public variable

FName

 

TextureFormatName

Format of the compressed texture, used to choose a compression DLL.

Public variable

FIntPoint

 

TopMipSize

The texture's top mip size without LODBias applied, should be moved into a separate struct together with bImageHasAlphaChannel

Public variable

int32

 

VirtualAddressingModeX

TextureAddress, opaque to avoid dependencies on engine headers.

Public variable

int32

 

VirtualAddressingModeY

Public variable

int32

 

VirtualTextureBorderSize

Size in pixels of border on virtual texture tile

Public variable

int32

 

VirtualTextureTileSize

Size in pixels of virtual texture tile, not including border

Public variable

int32

 

VolumeSizeZ

The volume texture's top mip size Z without LODBias applied

Constructors

Name Description

Public function

FTextureBuildSettings()

Default settings.

Functions

Name Description

Public function Const

EGammaSpace

 

GetGammaSpace()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss