className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
FChildTextureFormat::GetTiler | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Return the texture tiler for this platform. If present, then the texture build process will try to use the cached linear encoding for the texture as input rather than rebuilding the linear texture prior to tiling. Confusingly, this can not happen if the base texture formate returns true for SupportsTiling, as that refers to the texture encoder, not the format. | TextureFormat | virtual const [ITextureTiler](API\Developer\TextureFormat\Interfaces\ITextureTiler) * GetTiler() const | []
|
FChildTextureFormat::GetVersion | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Gets the current version of the specified texture format.
Version number. | TextureFormat | virtual uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) * BuildSettings ) const | []
|
FChildTextureFormat::PrepareTiling | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Prepares to compresses a single image with tiling. The result OutTilerSettings is used by SetTiling and CompressImageTiled.
true on success, false otherwise. | TextureFormat | virtual bool PrepareTiling ( const [FImage](API\Runtime\ImageCore\FImage) * Images, const uint32 NumImages, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, bool bImageHasAlphaChannel, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & OutTilerSettings, [TArray](API\Runtime\Core\Containers\TArray)< [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) > & OutCompressedImage ) const | []
|
FChildTextureFormat::ReleaseTiling | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Cleans up the FTilerSettings object once it is finished. | TextureFormat | virtual void ReleaseTiling ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & TilerSettings ) const | []
|
FChildTextureFormat::SetTiling | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Sets the tiling settings after device-specific tiling has been performed.
true on success, false otherwise. | TextureFormat | virtual bool SetTiling ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & TilerSettings, const TArray64< uint8 > & ReorderedBlocks, uint32 NumBlocks ) const | []
|
FChildTextureFormat::SupportsEncodeSpeed | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | Exposes whether the format supports the fast/final encode speed switching in project settings. Needs the Format so that we can thunk through the child texture formats correctly. | TextureFormat | virtual bool SupportsEncodeSpeed ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
FChildTextureFormat::FChildTextureFormat | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | TextureFormat | FChildTextureFormat ( const TCHAR * PlatformFormatPrefix ) | []
|
|
GetTextureFormatManager | /Engine/Source/Developer/TextureFormat/Public/TextureFormatManager.h | Return the Texture Format Manager interface, if it is available, otherwise return nullptr. | TextureFormat | [ITextureFormatManagerModule](API\Developer\TextureFormat\Interfaces\ITextureFormatManagerModule) * GetTextureFormatManager() | []
|
FChildTextureFormat | /Engine/Source/Developer/TextureFormat/Public/ChildTextureFormat.h | There are 3 ways a texture can get processed: ITextureFormat::IsTiling returns true. This should only be for the old Oodle RAD Game Tools supplied texture encoder and is being deprecated in favor of the new built-in Oodle texture encoder (TextureFormatOodle). In this case, the child format passes the images to the encoder to split apart prior to passing to the platform tools.FChildTextureFormat::GetTilerreturns nullptr. This is being phased out because the linear version of the input texture gets encoded for each platform with a post process, wasting cook time. In this case the child format encodes the "base" texture and then tiles it using the platform tools.FChildTextureFormat::GetTilerreturns a valid pointer. This is the most recent design. In this case, the child format is used as a holder of metadata and doesn't actually do any work (CompressImage class of functions not called). | TextureFormat | class FChildTextureFormat : public [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) | [
{
"type": "TArray<FName>",
"name": "BaseFormats",
"description": "List of base formats that. Combined with FormatPrefix, this contains all formats this can handle."
},
{
"type": "constFString",
"name": "FormatPrefix",
"description": "Prefix put before all formats from parent formats."
},
{
"type": "TArray<FName>",
"name": "SupportedFormatsCached",
"description": "List of combined BaseFormats with FormatPrefix."
}
]
|
GetTextureFormatManagerRef | /Engine/Source/Developer/TextureFormat/Public/TextureFormatManager.h | Return the Texture Format Manager interface, fatal error if it is not available. | TextureFormat | [ITextureFormatManagerModule](API\Developer\TextureFormat\Interfaces\ITextureFormatManagerModule) & GetTextureFormatManagerRef() | []
|
FEncodedTextureDescription::GetDescriptionForMipLevel | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the descriptionfor the single mip level(i.e. no further mips) | TextureFormat | [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) GetDescriptionForMipLevel ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 InMipIndex ) const | []
|
FEncodedTextureDescription::GetEncodedMipIterators | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | This handles mip chains whether or not they have packed mip tails. NoteGetNumEncodedMips()== OutMipTailIndex + 1 | TextureFormat | void GetEncodedMipIterators ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 & OutMipTailIndex, int32 & OutMipsInTail ) const | []
|
FEncodedTextureDescription::GetMipDepth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Always 1 unless volume texture. | TextureFormat | int32 GetMipDepth ( int32 InMipIndex ) const | []
|
FEncodedTextureDescription::GetMipDepth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | static int32 GetMipDepth ( int32 InTextureDepth, int32 InMipIndex, bool bInVolumeTexture ) | []
|
|
FEncodedTextureDescription::GetMipDimensions | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the size of the mip at the given index. Z is 1 unless it's a volume texture. | TextureFormat | FIntVector3 GetMipDimensions ( int32 InMipIndex ) const | []
|
FEncodedTextureDescription::GetMipHeight | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | int32 GetMipHeight ( int32 InMipIndex ) const | []
|
|
FEncodedTextureDescription::GetMipHeight | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | static int32 GetMipHeight ( int32 InTextureHeight, int32 InMipIndex ) | []
|
|
FEncodedTextureDescription::GetMipSizeInBytes | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the byte size of the unpacked/tiled mip. For mip chains that are packed or tiled, useFEncodedTextureExtendedData::MipSizesInBytes. | TextureFormat | uint64 GetMipSizeInBytes ( int32 InMipIndex ) const | []
|
FEncodedTextureDescription::GetMipWidth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | int32 GetMipWidth ( int32 InMipIndex ) const | []
|
|
FEncodedTextureDescription::GetMipWidth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | static int32 GetMipWidth ( int32 InTextureWidth, int32 InMipIndex ) | []
|
|
FEncodedTextureDescription::GetNumEncodedMips | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the number of mips that actually carry bulk data for this texture. Nominally the number of total mips, however some platforms have packed mip tails, which means they still have the total number of mips, but the last several are all bundled together for memory savings. | TextureFormat | int32 GetNumEncodedMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData ) const | []
|
FEncodedTextureDescription::GetNumSlices_NoDepth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the slice count for usage cases/platforms that expect slice count to only include cubemap/array slices. | TextureFormat | int32 GetNumSlices_NoDepth() const | []
|
FEncodedTextureDescription::GetNumSlices_WithDepth | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Returns the slice count for usage cases/platform that expect slice count to include volume texture depth. InMipIndex only affects volume textures. | TextureFormat | int32 GetNumSlices_WithDepth ( int32 InMipIndex ) const | []
|
FEncodedTextureDescription::GetNumStreamingMips | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | int32 GetNumStreamingMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, const [FTextureEngineParameters](API\Developer\TextureFormat\Interfaces\FTextureEngineParameters) & InEngineParameters ) const | []
|
|
FEncodedTextureDescription::operator== | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | bool operator== ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & OtherTextureDescription ) const | []
|
|
FEncodedTextureDescription::RemoveTopMips | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) RemoveTopMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 InRemoveCount ) const | []
|
|
FEncodedTextureDescription | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Everything necessary to know the memory layout for an encoded untiled unpacked texture (i.e. enough information to describe the texture entirely to a PC hardware API). Once a texture gets tiled or gets a packed mip tail, FEncodedTextureEncodedData is additionally required to know the memory layout. | TextureFormat | struct FEncodedTextureDescription | [
{
"type": "int32",
"name": "ArraySlices",
"description": ""
},
{
"type": "bool",
"name": "bCubeMap",
"description": ""
},
{
"type": "bool",
"name": "bTextureArray",
"description": ""
},
{
"type": "bool",
"name": "bVolumeTexture",
"description": ""
},
{
"type": "uint8",
"name": "NumMips",
"description": ""
},
{
"type": "EPixelFormat",
"name": "PixelFormat",
"description": ""
},
{
"type": "int32",
"name": "TopMipSizeX",
"description": ""
},
{
"type": "int32",
"name": "TopMipSizeY",
"description": ""
},
{
"type": "int32",
"name": "TopMipVolumeSizeZ",
"description": ""
}
]
|
FEncodedTextureExtendedData | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Extra data for an encoded texture. For "normal" textures (i.e. linear, without a packed mip tail), this must be all zeroes. | TextureFormat | struct FEncodedTextureExtendedData | [
{
"type": "bool",
"name": "bSensitiveToLODBias",
"description": "If true, this texture might change layouts if top mips are striped (i.e. LODBias is not zero)."
},
{
"type": "uint32",
"name": "ExtData",
"description": ""
},
{
"type": "int8",
"name": "LODBiasIfSensitive",
"description": "If bSensitiveToLODBias is set, this is the LODBias for this layout."
},
{
"type": "TArray< uint64,...",
"name": "MipSizesInBytes",
"description": "With packing/tiling, mip sizes are not trivially computable."
},
{
"type": "int32",
"name": "NumMipsInTail",
"description": ""
}
]
|
FTextureEngineParameters | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Created via GenerateTextureEngineParameters() in TextureDerivedDataTask.cpp. | TextureFormat | struct FTextureEngineParameters | [
{
"type": "bool",
"name": "bEngineSupportsTexture2DArrayStreaming",
"description": ""
},
{
"type": "bool",
"name": "bEngineSupportsVolumeTextureStreaming",
"description": ""
},
{
"type": "int32",
"name": "NumInlineDerivedMips",
"description": ""
}
]
|
FTextureFormatCompressorCaps | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Structure for texture format compressor capabilities. This struct is deprecated -FEncodedTextureExtendedDatais used instead. | TextureFormat | struct FTextureFormatCompressorCaps | []
|
FTextureFormatCompressorCaps::FTextureFormatCompressorCaps | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | FTextureFormatCompressorCaps() | []
|
|
GetNumStreamingMipsDirect | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | InNumMips The total mips that the texture contains. InExtendedData If the texture is being built for a platform that provides extended data, pass it here. For platforms that don't need it (i.e. PC), this should be nullptr. InEngineParameters Holds a vairety of engine configuration constants, create with GenerateEngineParameters() | TextureFormat | static int32 GetNumStreamingMipsDirect ( int32 InNumMips, bool bInCubeMap, bool bInVolumeTexture, bool bInTextureArray, const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, const [FTextureEngineParameters](API\Developer\TextureFormat\Interfaces\FTextureEngineParameters) & InEngineParameters ) | []
|
GetStreamingDisabledForNonVirtualTextureProperties | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | static bool GetStreamingDisabledForNonVirtualTextureProperties ( bool bInCubeMap, bool bInVolumeTexture, bool bInTextureArray, const [FTextureEngineParameters](API\Developer\TextureFormat\Interfaces\FTextureEngineParameters) & InEngineParameters ) | []
|
|
ITextureFormat::AllowParallelBuild | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Checks whether this texture format can compress in parallel.
true if parallel compression is supported, false otherwise. | TextureFormat | virtual bool AllowParallelBuild() const | []
|
ITextureFormat::CanAcceptNonF32Source | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | true in case Compress can handle other than RGBA32F image formats | TextureFormat | virtual bool CanAcceptNonF32Source ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
ITextureFormat::CompressImage | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Compresses a single image.
true on success, false otherwise. | TextureFormat | bool CompressImage ( const [FImage](API\Runtime\ImageCore\FImage) & Image, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, const FIntVector3 & InMip0Dimensions, int32 InMip0NumSlicesNoDepth, int32 InMipIndex, int32 InMipCount, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, struct [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) & OutCompressedImage ) const | []
|
ITextureFormat::CompressImageEx | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Compress an image (or images for a miptail) into a single mip blob.
true on success, false otherwise. | TextureFormat | virtual bool CompressImageEx ( const [FImage](API\Runtime\ImageCore\FImage) * Images, const uint32 NumImages, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, const FIntVector3 & InMip0Dimensions, int32 InMip0NumSlicesNoDepth, int32 InMipIndex, int32 InMipCount, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, uint32 ExtData, [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) & OutCompressedImage ) const | []
|
ITextureFormat::CompressImageTiled | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Compress an image (or images for a miptail) into a single mip blob with device-specific tiling.
true on success, false otherwise. | TextureFormat | virtual bool CompressImageTiled ( const [FImage](API\Runtime\ImageCore\FImage) * Images, uint32 NumImages, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & TilerSettings, struct [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) & OutCompressedImage ) const | []
|
ITextureFormat::ExportGlobalFormatConfig | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | This is only ever called during task creation - never in a build worker (FormatConfigOverride is empty)
The current format config object or an empty object if no format config is defined for this texture format. | TextureFormat | virtual [FCbObject](API\Runtime\Core\Serialization\FCbObject) ExportGlobalFormatConfig ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings ) const | []
|
FTilerSettings | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | An object produced by PrepareTiling and used by SetTiling and CompressImageTiled. This is used as an inheritance base for tiling formats to add their own information. | TextureFormat | struct FTilerSettings | []
|
ITextureFormat::GetAlternateTextureFormatPrefix | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | If this is an Alternate Texture Format, return the prefix to apply | TextureFormat | virtual [FString](API\Runtime\Core\Containers\FString) GetAlternateTextureFormatPrefix() const | []
|
ITextureFormat::GetChildFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | virtual const [FChildTextureFormat](API\Developer\TextureFormat\FChildTextureFormat) * GetChildFormat() const | []
|
|
ITextureFormat::GetDerivedDataKeyString | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Gets an optional derived data key string, so that the compressor can rely upon the number of mips, size of texture, etc, when compressing the image
A string that will be used with the DDC, the string should be in the format "_" | TextureFormat | virtual [FString](API\Runtime\Core\Containers\FString) GetDerivedDataKeyString ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, int32 InMipCount, const FIntVector3 & InMip0Dimensions ) const | []
|
ITextureFormat::GetEncodedPixelFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | bInImageHasAlphaChannel is whether or not to treat the source image format as having an alpha channel, independent of whether or not it actually has one. | TextureFormat | virtual EPixelFormat GetEncodedPixelFormat ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, bool bInImageHasAlphaChannel ) const | []
|
ITextureFormat::GetEncoderName | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Used for debugging and UI. | TextureFormat | [FName](API\Runtime\Core\UObject\FName) GetEncoderName ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
ITextureFormat::GetExtendedDataForTexture | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Generate and return any out-of-band data that needs to be saved for a given encoded texture description. This is for textures that have been transformed in some way for a platform. LODBias is needed because in some cases the tiling changes based on the top mip actually given to the hardware. | TextureFormat | virtual [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) GetExtendedDataForTexture ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & InTextureDescription, int8 InLODBias ) const | []
|
ITextureFormat::GetFormatCapabilities | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Gets the capabilities of the texture compressor. | TextureFormat | virtual [FTextureFormatCompressorCaps](API\Developer\TextureFormat\Interfaces\FTextureFormatCompressorCaps) GetFormatCapabilities() const | []
|
ITextureFormat::GetFormatCapabilitiesEx | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Gets the capabilities of the texture compressor. | TextureFormat | virtual [FTextureFormatCompressorCaps](API\Developer\TextureFormat\Interfaces\FTextureFormatCompressorCaps) GetFormatCapabilitiesEx ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, uint32 NumMips, const struct [FImage](API\Runtime\ImageCore\FImage) & ExampleImage, bool bImageHasAlphaChannel ) const | []
|
ITextureFormat::GetLatestSdkVersion | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Identify the latest sdk version for this texture encoder (note the SdkVersion is different than the TextureFormat Version) | TextureFormat | virtual [FName](API\Runtime\Core\UObject\FName) GetLatestSdkVersion() const | []
|
ITextureFormat::GetPixelFormatForImage | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Calculate the final/runtime pixel format for this image on this platform | TextureFormat | virtual EPixelFormat GetPixelFormatForImage ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, const struct [FImage](API\Runtime\ImageCore\FImage) & Image, bool bImageHasAlphaChannel ) const | []
|
ITextureFormat::GetSupportedFormats | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Gets the list of supported formats. | TextureFormat | void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const | []
|
ITextureFormat::GetVersion | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Gets the current version of the specified texture format.
Version number. | TextureFormat | uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) * BuildSettings ) const | []
|
ITextureFormat::PrepareTiling | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Prepares to compresses a single image with tiling. The result OutTilerSettings is used by SetTiling and CompressImageTiled.
true on success, false otherwise. | TextureFormat | virtual bool PrepareTiling ( const [FImage](API\Runtime\ImageCore\FImage) * Images, const uint32 NumImages, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, bool bImageHasAlphaChannel, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & OutTilerSettings, [TArray](API\Runtime\Core\Containers\TArray)< [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) > & OutCompressedImage ) const | []
|
ITextureFormat::ReleaseTiling | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Cleans up theFTilerSettingsobject once it is finished. | TextureFormat | virtual void ReleaseTiling ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & TilerSettings ) const | []
|
ITextureFormat::SetTiling | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Sets the tiling settings after device-specific tiling has been performed.
true on success, false otherwise. | TextureFormat | virtual bool SetTiling ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTilerSettings](API\Developer\TextureFormat\Interfaces\ITextureFormat\FTilerSettings) > & TilerSettings, const TArray64< uint8 > & ReorderedBlocks, uint32 NumBlocks ) const | []
|
ITextureFormat::SupportsEncodeSpeed | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Exposes whether the format supports the fast/final encode speed switching in project settings. Needs the Format so that we can thunk through the child texture formats correctly. | TextureFormat | virtual bool SupportsEncodeSpeed ( [FName](API\Runtime\Core\UObject\FName) Format ) const | []
|
ITextureFormat::SupportsTiling | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Whether device-specific tiling is supported by the compressor.
true if tiling is supported, false if it must be done by the caller | TextureFormat | virtual bool SupportsTiling() const | []
|
ITextureFormat::UsesTaskGraph | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Deprecated* Legacy API - do not use | TextureFormat | virtual bool UsesTaskGraph() const | []
|
ITextureFormat::~ITextureFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Virtual destructor. | TextureFormat | virtual ~ITextureFormat() | []
|
ITextureFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Note that if you add any virtual functions to this, they almost certainly need to be plumbed through ChildTextureFormat! This is why the Format is passed around - ChildTextureFormat needs it to resolve to the base format. | TextureFormat | class ITextureFormat | []
|
ITextureFormatManagerModule::FindTextureFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Finds a texture format with the specified name.
The texture format, or nullptr if not found. | TextureFormat | const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * FindTextureFormat ( [FName](API\Runtime\Core\UObject\FName) Name ) | []
|
ITextureFormatManagerModule::FindTextureFormatAndModule | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Finds a texture format with the specified name and provides information about the module it came from.
The texture format, or nullptr if not found. | TextureFormat | const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * FindTextureFormatAndModule ( [FName](API\Runtime\Core\UObject\FName) Name, [FName](API\Runtime\Core\UObject\FName) & OutModuleName, class [ITextureFormatModule](API\Developer\TextureFormat\Interfaces\ITextureFormatModule) *& OutModule ) | []
|
ITextureFormatManagerModule::GetTextureFormats | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Returns the list of all ITextureFormats that were located in DLLs.
Collection of texture formats. | TextureFormat | const [TArray](API\Runtime\Core\Containers\TArray)< const class [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * > & GetTextureFormats() | []
|
ITextureFormatManagerModule::Invalidate | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Invalidate should be called if any TextureFormat modules get loaded/unloaded/reloaded during runtime to give the implementation the chance to rebuild all its internal states and caches. | TextureFormat | void Invalidate() | []
|
ITextureFormatManagerModule::~ITextureFormatManagerModule | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Virtual destructor. | TextureFormat | ~ITextureFormatManagerModule() | []
|
ITextureFormatModule::CanCallGetTextureFormats | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatModule.h | Will this TextureFormat call back to Managermodule GetTextureFormats ? | TextureFormat | bool CanCallGetTextureFormats() | []
|
ITextureFormatModule::GetTextureFormat | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatModule.h | Gets the texture format.
The texture format interface. | TextureFormat | [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * GetTextureFormat() | []
|
ITextureFormatModule::~ITextureFormatModule | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatModule.h | Virtual destructor. | TextureFormat | ~ITextureFormatModule() | []
|
ITextureFormatModule | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatModule.h | Interface for texture format modules. | TextureFormat | class ITextureFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
ITextureTiler::GetExtendedDataForTexture | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | static const FUtf8StringView GetBuildFunctionNameStatic() staticFGuidGetBuildFunctionVersionGuid() Generate and return any out-of-band data that needs to be saved for a given encoded texture description and LODBias. | TextureFormat | [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) GetExtendedDataForTexture ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & InTextureDescription, int8 InLODBias ) const | []
|
ITextureTiler::ProcessMipLevel | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | InLinearSurfaces must have the necessary input mips for the mip level - i.e. for a packed mip tail, InMipIndex is the index of the top mip of the tail, and InLinearSurfaces must have all the source mips for the entire tail. | TextureFormat | [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) ProcessMipLevel ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & InTextureDescription, const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) & InExtendedData, [TArrayView](API\Runtime\Core\Containers\TArrayView)< FMemoryView > InLinearSurfaces, int32 InMipIndex ) const | []
|
ITextureTiler | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | Interface for platform formats that consume a linear, unpacked texture that an be built on a host platform (e.g. windows) and then tile/pack it as necessary. | TextureFormat | class ITextureTiler | []
|
ITextureFormatManagerModule | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormatManagerModule.h | Module for the texture format manager | TextureFormat | class ITextureFormatManagerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
ITextureTiler::GetBuildFunctionName | /Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h | TextureFormat | const FUtf8StringView GetBuildFunctionName() const | []
|
|
EToolMenuInsertType | /Engine/Source/Developer/ToolMenus/Public/ToolMenuMisc.h | ToolMenus | enum EToolMenuInsertType { Default, Before, After, First, } | []
|
|
EToolMenuStringCommandType | /Engine/Source/Developer/ToolMenus/Public/ToolMenuMisc.h | ToolMenus | enum EToolMenuStringCommandType { Command, Python, Custom, } | []
|
|
FGeneratedToolMenuWidget | /Engine/Source/Developer/ToolMenus/Public/ToolMenus.h | ToolMenus | struct FGeneratedToolMenuWidget | [
{
"type": "TObjectPtr<UTo...",
"name": "GeneratedMenu",
"description": ""
},
{
"type": "TWeakPtr<SWidg...",
"name": "Widget",
"description": ""
}
]
|
|
FGeneratedToolMenuWidgets | /Engine/Source/Developer/ToolMenus/Public/ToolMenus.h | ToolMenus | struct FGeneratedToolMenuWidgets | [
{
"type": "TArray<FGenera...",
"name": "Instances",
"description": ""
}
]
|
|
FNewSectionConstructChoice::IsBound | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | bool IsBound() const | []
|
|
FNewSectionConstructChoice::FNewSectionConstructChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewSectionConstructChoice() | []
|
|
FNewSectionConstructChoice::FNewSectionConstructChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewSectionConstructChoice ( const [FNewToolMenuDelegate](API\Developer\ToolMenus\FNewToolMenuDelegate) & InNewToolMenuDelegate ) | []
|
|
FNewSectionConstructChoice::FNewSectionConstructChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewSectionConstructChoice ( const [FNewToolMenuDelegateLegacy](API\Developer\ToolMenus\FNewToolMenuDelegateLegacy) & InNewToolMenuDelegateLegacy ) | []
|
|
FNewSectionConstructChoice::FNewSectionConstructChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewSectionConstructChoice ( const [FNewToolBarDelegateLegacy](API\Developer\ToolMenus\FNewToolBarDelegateLegacy) & InNewToolBarDelegateLegacy ) | []
|
|
FNewSectionConstructChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | struct FNewSectionConstructChoice | [
{
"type": "FNewToolBarDele...",
"name": "NewToolBarDelegateLegacy",
"description": ""
},
{
"type": "FNewToolMenuDel...",
"name": "NewToolMenuDelegate",
"description": ""
},
{
"type": "FNewToolMenuDel...",
"name": "NewToolMenuDelegateLegacy",
"description": ""
}
]
|
|
FNewToolBarDelegateLegacy | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_TwoParams< void, class [FToolBarBuilder](API\Runtime\Slate\Framework\MultiBox\FToolBarBuilder) &, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolBarDelegateLegacy | []
|
|
FNewToolMenuChoice::FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewToolMenuChoice() | []
|
|
FNewToolMenuChoice::FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewToolMenuChoice ( const FOnGetContent & InOnGetContent ) | []
|
|
FNewToolMenuChoice::FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewToolMenuChoice ( const [FNewToolMenuWidget](API\Developer\ToolMenus\FNewToolMenuWidget) & InNewToolMenuWidget ) | []
|
|
FNewToolMenuChoice::FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewToolMenuChoice ( const [FNewToolMenuDelegate](API\Developer\ToolMenus\FNewToolMenuDelegate) & InNewToolMenu ) | []
|
|
FNewToolMenuChoice::FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | FNewToolMenuChoice ( const FNewMenuDelegate & InNewMenuLegacy ) | []
|
|
FNewToolMenuChoice | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | struct FNewToolMenuChoice | [
{
"type": "FNewMenuDelegat...",
"name": "NewMenuLegacy",
"description": ""
},
{
"type": "FNewToolMenuDel...",
"name": "NewToolMenu",
"description": ""
},
{
"type": "FNewToolMenuWid...",
"name": "NewToolMenuWidget",
"description": ""
},
{
"type": "FOnGetContent",
"name": "OnGetContent",
"description": ""
}
]
|
|
FNewToolMenuCustomWidget | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_TwoParams< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) &, const [FToolMenuCustomWidgetContext](API\Developer\ToolMenus\FToolMenuCustomWidgetContext) & > FNewToolMenuCustomWidget | []
|
|
FNewToolMenuDelegate | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_OneParam< void, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolMenuDelegate | []
|
|
FNewToolMenuDelegateLegacy | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_TwoParams< void, class [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) &, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolMenuDelegateLegacy | []
|
|
FNewToolMenuSectionDelegate | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_OneParam< void, [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & > FNewToolMenuSectionDelegate | []
|
|
FNewToolMenuWidget | /Engine/Source/Developer/ToolMenus/Public/ToolMenuDelegates.h | ToolMenus | typedef TBaseDelegate_OneParam< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FNewToolMenuWidget | []
|
|
FScriptSlateIcon::GetSlateIcon | /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntryScript.h | ToolMenus | [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) GetSlateIcon() const | []
|
|
FScriptSlateIcon::operator FSlateIcon | /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntryScript.h | ToolMenus | operator FSlateIcon() const | []
|
|
FScriptSlateIcon::FScriptSlateIcon | /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntryScript.h | ToolMenus | FScriptSlateIcon() | []
|
|
FScriptSlateIcon::FScriptSlateIcon | /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntryScript.h | ToolMenus | FScriptSlateIcon ( const [FName](API\Runtime\Core\UObject\FName) InStyleSetName, const [FName](API\Runtime\Core\UObject\FName) InStyleName ) | []
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.