1. Epic GamesDeveloper
  3. FTextureBuildSettings

FTextureBuildSettings

Texture build settings.

Unreal Engine C++ API Reference > Developer > TextureCompressor

References

   
Module TextureCompressor
Header /Engine/Source/Developer/TextureCompressor/Public/TextureCompressorModule.h
Include #include "TextureCompressorModule.h"

Syntax

struct FTextureBuildSettings

Remarks

Texture build settings.

Variables

  Type Name Description
Public variable FVector4f AlphaCoverageThresholds Channel values to compare to when preserving alpha coverage.
Public variable bool bAffectedBySharedLinearEncoding If shared linear is enabled at all and this texture in involved with that at all then we set this so we can segregate the derived data keys.
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 const ITextureFormat * BaseTextureFormat Cached pointer to BaseTextureFormatName. Resolved in FinalizeBuildSettingsForLayer and ResolveBuildSettings.
Public variable FName BaseTextureFormatName If we have a child format, this is the base format (i.e. will have the platform prefix removed).
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 bCPUAccessible If set, the texture will generate a tiny placeholder hw texture and save off a copy of the top mip for CPU access.
Public variable uint32: 1 bCubemap Whether the texture being built is a cubemap.
Public variable bool bDecodeForPCUsage If true, after encoding and potentially tiling, convert the texture back to something a PC can render so we can view the final encoding.
Public variable bool bDoScaleMipsForAlphaCoverage Enable preserving alpha coverage.
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 uint32: 1 bForceAlphaChannel Whether we should not discard the alpha channel when it contains 1 for the entire texture.
Public variable uint32: 1 bForceNoAlphaChannel Whether we should discard the alpha channel even if it contains non-zero values in the pixel data.
Public variable bool bHasColorSpaceDefinition Whether the texture has a defined source color space.
Public variable bool bHasTransparentAlpha Only valid if bKnowAlphaTransparency is true.
Public variable bool bHDRSource Whether the texture being built contains HDR source data
Public variable bool bKnowAlphaTransparency Whether bHasTransparentAlpha is valid.
Public variable uint32: 1 bLongLatSource Whether the texture being built from long/lat source to cubemap.
Public variable FVector2f BlueChromaticityCoordinate Blue chromaticity coordinate of the source color space.
Public variable bool bNormalizeNormals Normalize normals after mip gen, before compression
Public variable bool bOodlePreserveExtremes If set to true, then Oodle encoder preserves 0 and 255 (0.0 and 1.0) values exactly in alpha channel for BC3/BC7 and in all channels for BC4/BC5.
Public variable bool bOodleUsesRDO  
Public variable bool bPadWithBorderColor If set to true, texture padding will be performed using colors of the border pixels in order to improve quality of the generated mipmaps.
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_Unused 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 bool bUseNewMipFilter Use newer & faster mip generation filter
Public variable uint32: 1 bVirtualStreamable Is the texture streamed using the VT system
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 uint8 ChromaticAdaptationMethod Chromatic adaption method applied if the source white point differs from the working color space white point.
Public variable FColorAdjustmentParameters 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) only used by ASTC formats right now.
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 FCbObjectView FormatConfigOverride Format specific config object view or null if no format specific config is applied as part of this build.
Public variable FVector2f GreenChromaticityCoordinate Green chromaticity coordinate of the source color space.
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 - oodle resolves this to RDO lambda during fast/final resolution.
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 uint8 OodleEncodeEffort  
Public variable uint8 OodleRDO Encoding settings resolved from fast/final.
Public variable FName OodleTextureSdkVersion Which version of Oodle Texture to encode with
Public variable uint8 OodleUniversalTiling  
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 FVector2f RedChromaticityCoordinate Red chromaticity coordinate of the source color space.
Public variable uint8 RepresentsEncodeSpeedNoSend Which encode speed this build settings represents.
Public variable int32 ResizeDuringBuildX Width of the resized texture when using "Resize To Specific Resolution" padding and resizing option.
Public variable int32 ResizeDuringBuildY Width of the resized texture when using "Resize To Specific Resolution" padding and resizing option.
Public variable uint32 SharpenMipKernelSize The size of the kernel with which mips should be sharpened.
Public variable uint8 SourceEncodingOverride Advanced source encoding of the image.
Public variable uint8 TextureAddressModeX "TextureAddress" enum values : (TA_Wrap default)
Public variable uint8 TextureAddressModeY  
Public variable uint8 TextureAddressModeZ  
Public variable FName TextureFormatName Format of the compressed texture, used to choose a compression DLL.
Public variable const ITextureTiler * Tiler If the target format is a tiled format and can leverage reusing the linear encoding, this is not nullptr.
Public variable const ITextureTiler * TilerEvenIfNotSharedLinear If the target format has a tiler we store it here independent of shared linear.
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 FVector2f WhiteChromaticityCoordinate White chromaticity coordinate of the source color space.

Constructors

  Type Name Description
Public function   Default settings.

Functions

  Type Name Description
Public function Const EGammaSpace  
Public function Const void

GetEncodedTextureDescription ( FEncodedTextureDescription* OutTextureDescription,
const ITextureFormat* InTextureFormat,
int32 InEncodedMip0SizeX,
int32 InEncodedMip0SizeY,
int32 InEncodedMip0NumSlices,
int32 InMipCount,
bool bInImageHasAlphaChannel
)

 Convert the build settings to an actual texture description containing enough information to describe the texture to hardware APIs.
Public function Const bool

GetEncodedTextureDescriptionFromSourceMips ( FEncodedTextureDescription* OutTextureDescription,
const ITextureFormat* InTextureFormat,
int32 InSourceMip0SizeX,
int32 InSourceMip0SizeY,
int32 InSourceMip0NumSlices,
int32 InSourceMipCount,
bool bInImageHasAlphaChannel
)

 As per GetEncodedTextureDescription but the mip sizes are pre encoding. Return false for same reasons as GetOutputMipInfo.
Public function Const void

GetEncodedTextureDescriptionWithPixelFormat ( FEncodedTextureDescription* OutTextureDescription,
EPixelFormat InEncodedPixelFormat,
int32 InEncodedMip0SizeX,
int32 InEncodedMip0SizeY,
int32 InEncodedMip0NumSlices,
int32 InMipCount
)

  
Public function Const EGammaSpace  
Public function Static uint32 Obtain the OpenColorIO library version, primarily used for DDC invalidation.
Public function Const bool

GetOutputAlphaFromKnownAlphaOrFail ( bool* bOutOutputHasAlpha
)

 Returns false if we can't determine instead of passing through a fallback
Public function Const void

GetOutputAlphaFromKnownAlphaOrFallback ( bool* bOutOutputHasAlpha,
bool bUnknownSourceAlphaFallback
)

 BUnknownSourceAlphaFallback is whether we should treat the source as having alpha, in cases where the source alpha is unknown
Public function Const bool

GetOutputMipInfo ( int32 InMip0SizeX,
int32 InMip0SizeY,
int32 InMip0NumSlices,
int32 InExistingMipCount,
int32& OutMip0SizeX,
int32& OutMip0SizeY,
int32& OutMip0NumSlices,
int32& OutMipCount
)

 Return the expected size and mip count for a texture processed with these build settings.
Public function Const EGammaSpace GammaSpace is TextureCompressorModule is always a Destination gamma we get FImages as input with source gamma space already set on them
Public function Const bool

GetTextureExpectsAlphaInPixelFormat ( bool bInSourceMipsAlphaDetected
)

 If there is a choice to be had between two formats: one with alpha and one without, this returns which one the texture expects.

Constants

Name Description
MaxTextureResolutionDefault  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page