description: Returns the config system object usable by this TargetPlatform. It should not be modified in anyway

code: [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * GetConfigSystem() const


description: Returns custom DeviceManager widget creator for this platform

module: TargetPlatform


description:
Note that not all platforms may have a notion of default devices.
Default device.


description:
Gets an interface to the specified device.
The target device (can be nullptr).

code: [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) GetDevice ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & DeviceId )


description:
Gets down sample mesh distance field divider.
1 if platform does not need to downsample mesh distance fields


description: Gets a list of package names to cook when cooking this platform

code: void GetExtraPackagesToCook ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & PackageNames ) const


description:
Gets an integer representing the height fog mode for opaque materials on a platform.
0 if no override (i.e. use r.VertexFoggingForOpaque from project settings); 1 if pixel fog; 2 if vertex fog.

code: int32 GetHeightFogModeForOpaque() const


description:
Gets the alignment of memory mapping for this platform, typically the page size.
alignment of memory mapping.

code: int64 GetMemoryMappingAlignment() const


description: Given a platform ordinal number, returns the correspondingITargetPlatforminstance

code: static const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * GetPlatformFromOrdinal ( int32 Ordinal )


description: Returns the information about the platform as a whole

code: const [FDataDrivenPlatformInfo](API\Runtime\Core\Misc\FDataDrivenPlatformInfo) & GetPlatformInfo() const


description:
The implementation will assign an ordinal to each target platform at startup, assigning a value of 0, 1, 2, etc in order to make the ordinals usable as array / bit mask indices.
int32 A unique integer which may be used to identify target platform during the current session only (note: not stable across runs).

code: int32 GetPlatformOrdinal() const


description: Gather per-project cook/package analytics

code: void GetPlatformSpecificProjectAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & AnalyticsParamArray ) const


description: Gets the shader formats that support ray tracing for this target platform.

code: void GetRayTracingShaderFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description: Return the TargetType this platform uses at runtime. Some TargetPlatforms like CookedEditors need to cook with one type, like Client, but then will run as an Editor. Decisions made based solely on the cook type may cause data mismatches if the runtime type is different. This is also useful for knowing what plugins will be enabled at runtime.


description: Provide platform specific file dependency patterns for SN-DBS shader compilation.

code: void GetShaderCompilerDependencies ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutDependencies ) const


description: Gets static mesh offline BVH mode


description: Returns the information about this target platform

code: const [PlatformInfo::FTargetPlatformInfo](API\Developer\DesktopPlatform\FTargetPlatformInfo) & GetTargetPlatformInfo() const


description:
Gets the variant priority of this platform
float priority for this platform variant.

code: float GetVariantPriority() const


description:
Gets a new compression format to use in place of Zlib. This should be rarely implemented
Compression format to use instead of Zlib


description:
Checks whether this platform has only editor data (typically desktop platforms).
true if this platform has editor only data, false otherwise.

code: bool HasEditorOnlyData() const


description:
Checks whether this platform has a secure shippable package format, and therefore doesn't need any encryption or signing support
true if this platform requires cooked data, false otherwise.

code: bool HasSecurePackageFormat() const


description: PlatformName


description: Initializes the host platform to support target devices (may be called multiple times after an SDK is installed while running)

code: bool InitializeHostPlatform()


description:
Checks whether this platform is only a client (and must connect to a server to run).
true if this platform must connect to a server.

code: bool IsClientOnly() const


description: Checks whether this platform is enabled for the given plugin in the currently active project.

code: bool IsEnabledForPlugin ( const [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) & Plugin ) const


description:
Checks whether this platform is little endian.
true if this platform is little-endian, false otherwise.

code: bool IsLittleEndian() const


description:
For example, when running on Windows, the WindowsITargetPlatformwill return true and all other platforms will return false.
true if this platform is running, false otherwise.

code: bool IsRunningPlatform() const


description:
Checks whether the platform's SDK requirements are met so that we can do things like package for the platform
true if the platform is ready for use

code: bool IsSdkInstalled ( bool bProjectHasCode, [FString](API\Runtime\Core\Containers\FString) & OutDocumentationPath ) const


description:
Checks whether this platform is only a server.
true if this platform has no graphics or audio, etc, false otherwise.

code: bool IsServerOnly() const


description:
Package a build for the given platform
bool true on success, false otherwise.

code: bool PackageBuild ( const [FString](API\Runtime\Core\Containers\FString) & InPackgeDirectory )


description: DisplayName


description:
Checks whether this platform requires cooked data (typically console platforms).
true if this platform requires cooked data, false otherwise.

code: bool RequiresCookedData() const


description:
Checks whether this platform requires the originally released version (in addition to the previously released version) to create a patch
true if this platform requires the originally released version, false otherwise.


description:
Checks whether the current project needs a temporary .target.cs file to be packaged as a code project.
True if a temporary target is required

code: bool RequiresTempTarget ( bool bProjectHasCode, EBuildConfiguration Configuration, bool bRequiresAssetNativization, [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


description:
Checks whether this platform requires user credentials (typically server platforms).
enum if this platform requires user credentials.


description: Whether or not to send all lower-case filepaths when connecting over a fileserver connection.

code: bool SendLowerCaseFilePaths() const


description: Returns wheter or not this 16bit index buffer should be promoted to 32bit

code: bool ShouldExpandTo32Bit ( const uint16 * Indices, const int32 NumIndices ) const


description: Returns true if the platform supports the AutoSDK system

code: bool SupportsAutoSDK() const


description:
Checks whether this platform supports the specified build target, i.e. Game or Editor.
true if the build target is supported, false otherwise.

code: bool SupportsBuildTarget ( EBuildTargetType TargetType ) const


description:
Checks whether the target platform supports the specified feature.
true if the feature is supported, false otherwise.

code: bool SupportsFeature ( [ETargetPlatformFeatures](API\Developer\TargetPlatform\Interfaces\ETargetPlatformFeatures) Feature ) const


description:
Checks whether the target platform supports the specified value for the specified type of support
true if the feature is supported, false otherwise.

code: bool SupportsValueForType ( [FName](API\Runtime\Core\UObject\FName) SupportedType, [FName](API\Runtime\Core\UObject\FName) RequiredSupportedValue ) const


description: Returns true if the platform is part of a family of variants

code: bool SupportsVariants() const


description: Gets whether the platform uses ASTC HDR

code: bool UsesASTCHDR() const


description: Gets whether the platform should output velocity in the base pass.

code: bool UsesBasePassVelocity() const


description: Gets whether the platform should use DBuffer for decals.

code: bool UsesDBuffer() const


description: Gets whether the platform will use distance fields.

code: bool UsesDistanceFields() const


description: Gets whether the platform should use forward shading or not.

code: bool UsesForwardShading() const


description: Gets whether the platform uses Mobile AO

code: bool UsesMobileAmbientOcclusion() const


description: Gets whether the platform will use ray tracing.

code: bool UsesRayTracing() const


description: Gets whether the platform will use selective outputs in the base pass shaders.


description: Gets whether the platform will encode depth velocity.

code: bool VelocityEncodeDepth() const


className: ITargetPlatform

description: This interface provides an abstraction for cooking platforms and enumerating actual target devices.

code: class ITargetPlatform


description:
Finds an audio format with the specified name.
The audio format, or nullptr if not found.

code: const [IAudioFormat](API\Developer\TargetPlatform\Interfaces\IAudioFormat) * FindAudioFormat ( [FName](API\Runtime\Core\UObject\FName) Name )


description:
Finds a PhysX format with the specified name.
The PhysX format, or nullptr if not found.

code: const IPhysXCooking * FindPhysXCooking ( [FName](API\Runtime\Core\UObject\FName) Name )


description:
Finds a shader format with the specified name.
The shader format, or nullptr if not found.

code: const [IShaderFormat](API\Developer\TargetPlatform\Interfaces\IShaderFormat) * FindShaderFormat ( [FName](API\Runtime\Core\UObject\FName) Name )


description:
Finds a target device by identifier.
The target device, or nullptr if not found.

code: [ITargetDevicePtr](API\Developer\TargetPlatform\Interfaces\ITargetDevicePtr) FindTargetDevice ( const [FTargetDeviceId](API\Developer\TargetPlatform\Interfaces\FTargetDeviceId) & DeviceId )


description:
Finds a target platform by name.
The target platform, or nullptr if not found.

code: [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * FindTargetPlatform ( FStringView Name )


code: [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * FindTargetPlatform ( const TCHAR * Name )


code: [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * FindTargetPlatform ( [FName](API\Runtime\Core\UObject\FName) Name )


description: Virtual destructor.

code: virtual ~ITargetPlatform()


description:
Finds a target platform by looking for one that supports a given value for a generic type of support
The target platform, or nullptr if not found.

code: [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * FindTargetPlatformWithSupport ( [FName](API\Runtime\Core\UObject\FName) SupportType, [FName](API\Runtime\Core\UObject\FName) RequiredSupportedValue )


description:
Finds a texture format with the specified name.
The texture format, or nullptr if not found.

code: const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * FindTextureFormat ( [FName](API\Runtime\Core\UObject\FName) Name )


description:
Return the list of the ITargetPlatforms that we want to build data for.
Collection of platforms.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * > & GetActiveTargetPlatforms()


description:
Returns the list of all IAudioFormats that were located in DLLs.
Collection of audio formats.

code: const [TArray](API\Runtime\Core\Containers\TArray)< const class [IAudioFormat](API\Developer\TargetPlatform\Interfaces\IAudioFormat) * > & GetAudioFormats()


description:
Return the list of platforms which we need to support when cooking (only set when actually cooking)
Collection of platforms.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * > & GetCookingTargetPlatforms()


description: A callback that holders of ITargetPlatform* must subscribe to to be notified of when the ITargetPlatform* has been invalidated and should be requeried from e.g. FindTargetPlatform


description:
Returns the list of all IPhysXCooking that were located in DLLs.
Collection of PhysX formats.

code: const [TArray](API\Runtime\Core\Containers\TArray)< const class IPhysXCooking * > & GetPhysXCooking()


description:
Note: This method only returns a Target Platform when WITH_EDITOR.
Running target platform.


description:
Returns the list of all ITextureFormats that were located in DLLs.
Collection of shader formats.

code: const [TArray](API\Runtime\Core\Containers\TArray)< const class [IShaderFormat](API\Developer\TargetPlatform\Interfaces\IShaderFormat) * > & GetShaderFormats()


description:
Returns the list of all ITargetPlatforms that were located in DLLs.
Collection of platforms.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * > & GetTargetPlatforms()


description:
Returns the list of all ITextureFormats that were located in DLLs.
Collection of texture formats.

code: const [TArray](API\Runtime\Core\Containers\TArray)< const class [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * > & GetTextureFormats()


description:
Determine if there were errors during the initialization of the platform manager.
True if there were errors during the initialization of the platform manager, False otherwise.

code: bool HasInitErrors ( [FString](API\Runtime\Core\Containers\FString) * OutErrorMessages ) const


description: Invalidate should be called if any TargetPlatform modules get loaded/unloaded/reloaded during runtime to give the implementation the chance to rebuild all its internal states and caches.

code: void Invalidate()


description:
Checks whether we should only build formats that are actually required for use by the runtime.
true if formats are restricted, false otherwise.

code: bool RestrictFormatsToRuntimeOnly()


description: After installing an SDK with Turnkey, this will refresh the TargetPlatform, find devices, etc

code: bool UpdateAfterSDKInstall ( [FName](API\Runtime\Core\UObject\FName) TargetPlatformName )


description:
Gets the shader format version for the specified shader.
Version number.

code: uint32 ShaderFormatVersion ( [FName](API\Runtime\Core\UObject\FName) Name )


description: Allows changes to environment for a given platform

code: bool UpdatePlatformEnvironment ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Keys, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Values )


description: Virtual destructor.

code: ~ITargetPlatformManagerModule()


className: ITargetPlatformManagerModule

description: Module for the target platform manager

code: class ITargetPlatformManagerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Gets the module's target platforms. This should be overridden by each platform, but currently, we are re-using the single internal GetTargetPlatform method the old TPModules will implement
The target platform.

code: [TArray](API\Runtime\Core\Containers\TArray)< [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * > GetTargetPlatforms()


description: This is where each platform module will fill out an array

code: void GetTargetPlatforms ( [TArray](API\Runtime\Core\Containers\TArray)< [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * > & TargetPlatforms )


description: Virtual destructor.

code: virtual ~ITargetPlatformModule()


className: ITargetPlatformModule

description: Interface for target platform modules.

code: class ITargetPlatformModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Returns the string representation of the specified ETargetDeviceTypes value.
A string value.

code: namespace TargetDeviceTypes { [FString](API\Runtime\Core\Containers\FString) TargetDeviceTypes::ToString ( [ETargetDeviceTypes](API\Developer\TargetPlatform\Interfaces\ETargetDeviceTypes) DeviceType ) }


className: FGenericTextureTilingBuildFunction

description: This build function expects an implementation ofITextureTileras its template and looks a bit awkward because IBuildFunction is required to not have any state, so we can't put the instance of theITextureTileron our object - hence the odd statics.

module: TextureBuild

code: template<class ITextureTilerObject> class FGenericTextureTilingBuildFunction : public [UE::DerivedData::IBuildFunction](API\Developer\DerivedDataCache\IBuildFunction)


description: The build is considered to be successful unless an error was logged during its execution.

code: virtual void Build ( [UE::DerivedData::FBuildContext](API\Developer\DerivedDataCache\FBuildContext) & Context ) const


description: The default configuration is to use the function name as the cache bucket, use the default cache policy, use the default build policy, and enable non-deterministic output checks.

code: virtual void Configure ( [UE::DerivedData::FBuildConfigContext](API\Developer\DerivedDataCache\FBuildConfigContext) & Context ) const


description: Returns the version of the build function, which must change when the function changes.

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetVersion() const


code: void GetVersion ( [UE::DerivedData::FBuildVersionBuilder](API\Developer\DerivedDataCache\FBuildVersionBuilder) & Builder, [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) *& OutTextureFormatVersioning ) const


className: FTextureBuildFunction

code: class FTextureBuildFunction : public [UE::DerivedData::IBuildFunction](API\Developer\DerivedDataCache\IBuildFunction)


className: GenericTextureTilingBuildFunction

description: This function does the meat of breaking out the inputs from the build context and handing them to the tiler, then packing them back up for the build process.

code: void GenericTextureTilingBuildFunction ( [UE::DerivedData::FBuildContext](API\Developer\DerivedDataCache\FBuildContext) & Context, const [ITextureTiler](API\Developer\TextureFormat\Interfaces\ITextureTiler) * Tiler, const [UE::DerivedData::FUtf8SharedString](API\Developer\DerivedDataCache\FUtf8SharedString) & BuildFunctionName )


module: TextureBuildUtilities

code: FTextureBuildMetadata()


code: FTextureBuildMetadata ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) InCbObject )


className: FTextureBuildMetadata

description: Carries information out of the build that we don't want to cook or save off in the runtime.

code: struct FTextureBuildMetadata

bSourceMipsAlphaDetected

type: bool

description: Whether or not the first mip level of the source has alpha detected.

PreEncodeMipsHash

description: Digests of the data at various processing stages so we can track down determinism issues that arise.


code: namespace UE { namespace TextureBuildUtilities { const [FName](API\Runtime\Core\UObject\FName) UE::TextureBuildUtilities::TextureFormatRemovePrefixFromName ( [FName](API\Runtime\Core\UObject\FName) const & InName ) } }


description: Constructor

module: TextureCompressor

code: FColorAdjustmentParameters()


className: FColorAdjustmentParameters

description: Color adjustment parameters.

code: struct FColorAdjustmentParameters

AdjustBrightness

type: float

description: Brightness adjustment (scales HSV value)

AdjustBrightnessCurve

description: Curve adjustment (raises HSV value to the specified power)

AdjustHue

description: Hue adjustment (offsets HSV hue by value in degrees)

AdjustMaxAlpha

description: Remaps the alpha to the specified min/max range (Non-destructive; Requires texture source art to be available.)

AdjustRGBCurve

description: RGB curve adjustment (raises linear-space RGB color to the specified power)

AdjustSaturation

description: Saturation adjustment (scales HSV saturation)

AdjustVibrance

description: "Vibrance" adjustment (HSV saturation algorithm adjustment)


description: Compressed image data.

code: struct FCompressedImage2D

RawData

type: TArray64< uint8...

SizeX

description: In the past Sizes here were aligned up to a compressed block size multiple that is no longer done, the real size is stored


code: EGammaSpace GetDestGammaSpace() const


description: Convert the build settings to an actual texture description containing enough information to describe the texture to hardware APIs.

code: void GetEncodedTextureDescription ( [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) * OutTextureDescription, const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * InTextureFormat, int32 InEncodedMip0SizeX, int32 InEncodedMip0SizeY, int32 InEncodedMip0NumSlices, int32 InMipCount, bool bInImageHasAlphaChannel ) const


code: void GetEncodedTextureDescriptionWithPixelFormat ( [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) * OutTextureDescription, EPixelFormat InEncodedPixelFormat, int32 InEncodedMip0SizeX, int32 InEncodedMip0SizeY, int32 InEncodedMip0NumSlices, int32 InMipCount ) const


description: Deprecated* Use GetDestGammaSpace or GetSourceGammaSpace (probably Dest)

code: EGammaSpace GetGammaSpace() const


description: Obtain the OpenColorIO library version, primarily used for DDC invalidation.

code: static uint32 GetOpenColorIOVersion()


description: GammaSpace is TextureCompressorModule is always a Destination gamma we get FImages as input with source gamma space already set on them

code: EGammaSpace GetSourceGammaSpace() const


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

code: bool GetTextureExpectsAlphaInPixelFormat ( bool bInSourceMipsAlphaDetected ) const


className: MaxTextureResolutionDefault

code: static constexpr uint32 MaxTextureResolutionDefault = TNumericLimits<uint32>::Max();


description: Default settings.

code: FTextureBuildSettings()


className: FTextureBuildSettings

description: Texture build settings.

code: struct FTextureBuildSettings

AlphaCoverageThresholds

description: Channel values to compare to when preserving alpha coverage.

bAffectedBySharedLinearEncoding

description: If shared linear is enabledat alland this texture in involved with thatat allthen we set this so we can segregate the derived data keys.

bApplyKernelToTopMip

type: uint32:  1

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

bApplyYCoCgBlockScale

description: Calculate and apply a scale for YCoCg textures.

BaseTextureFormatName

type: FName

description: If we have a child format, this is the base format (i.e. will have the platform prefix removed).

bBorderColorBlack

description: Whether the border color should be black.

bChromaKeyTexture

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

bComputeBokehAlpha

description: Whether bokeh alpha values should be computed for the texture.

bCubemap

description: Whether the texture being built is a cubemap.

bDoScaleMipsForAlphaCoverage

description: Enable preserving alpha coverage.

bDownsampleWithAverage

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

bFlipGreenChannel

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

bForceAlphaChannel

description: Whether we should not discard the alpha channel when it contains 1 for the entire texture.

bForceNoAlphaChannel

description: Whether we should discard the alpha channel even if it contains non-zero values in the pixel data.

bHasColorSpaceDefinition

description: Whether the texture has a defined source color space.

bHDRSource

description: Whether the texture being built contains HDR source data

bLongLatSource

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

BlueChromaticityCoordinate

description: Blue chromaticity coordinate of the source color space.

bNormalizeNormals

description: Normalize normals after mip gen, before compression

bPreserveBorder

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

bRenormalizeTopMip

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

bReplicateAlpha

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

bReplicateRed

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

bSharpenWithoutColorShift

description: Whether sharpening should prevent color shifts.

bSRGB

description: Whether the texture contains color data in the sRGB colorspace.

description: Can the texture be streamed.

bTextureArray

description: Whether the texture being built is a texture array.

bUseLegacyGamma

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

bUseNewMipFilter

description: Use newer & faster mip generation filter

bVirtualStreamable

description: Is the texture streamed using the VT system

bVolume

description: Whether the texture being built is a volume.

ChromaKeyColor

type: FColor

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

ChromaKeyThreshold

description: 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)

ChromaticAdaptationMethod

description: Chromatic adaption method applied if the source white point differs from the working color space white point.

ColorAdjustment

type: FColorAdjustmen...

description: Color adjustment parameters.

CompositePower

description: Default 1, high values result in a stronger effect

CompositeTextureMode

description: E.g. CTM_RoughnessFromNormalAlpha

CompressionQuality

description: 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.

DiffuseConvolveMipLevel

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

DownscaleOptions

description: ETextureDownscaleOptions

FormatConfigOverride

type: FCbObjectView

description: Format specific config object view or null if no format specific config is applied as part of this build.

GreenChromaticityCoordinate

description: Green chromaticity coordinate of the source color space.

LODBias

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

LossyCompressionAmount

description: ETextureLossyCompressionAmount - oodle resolves this to RDO lambda during fast/final resolution.

MaxTextureResolution

description: For maximum resolution.

MipGenSettings

description: Mipmap generation settings.

MipSharpening

description: The desired amount of mip sharpening.

OodleRDO

description: Encoding settings resolved from fast/final.

OodleTextureSdkVersion

description: Which version of Oodle Texture to encode with

PaddingColor

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

PowerOfTwoMode

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

RedChromaticityCoordinate

description: Red chromaticity coordinate of the source color space.

RepresentsEncodeSpeedNoSend

description: Which encode speed this build settings represents.

SharpenMipKernelSize

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

SourceEncodingOverride

description: Advanced source encoding of the image.

TextureAddressModeX

description: "TextureAddress" enum values : (TA_Wrap default)

TextureFormatName

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

Tiler

type: constITextureT...

description: If the target format is a tiled format and can leverage reusing the linear encoding, this is not nullptr.

VirtualAddressingModeX

description: TextureAddress, opaque to avoid dependencies on engine headers.

VirtualTextureBorderSize

description: Size in pixels of border on virtual texture tile

VirtualTextureTileSize

description: Size in pixels of virtual texture tile, not including border

WhiteChromaticityCoordinate

description: White chromaticity coordinate of the source color space.


description: Adjusts the colors of the image using the specified settings

code: static void AdjustImageColors ( [FImage](API\Runtime\ImageCore\FImage) & Image, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings )


description:
Builds a texture from source images.
true on success

code: bool BuildTexture ( const [TArray](API\Runtime\Core\Containers\TArray)< struct [FImage](API\Runtime\ImageCore\FImage) > & SourceMips, const [TArray](API\Runtime\Core\Containers\TArray)< struct [FImage](API\Runtime\ImageCore\FImage) > & AssociatedNormalSourceMips, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, FStringView DebugTexturePathName, [TArray](API\Runtime\Core\Containers\TArray)< [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) > & OutTextureMips, uint32 & OutNumMipsInTail, uint32 & OutExtData, [UE::TextureBuildUtilities::FTextureBuildMetadata](API\Developer\TextureBuildUtilities\FTextureBuildMetadata) * OutMetadata )


description: Generates angularly filtered mips.

code: static void GenerateAngularFilteredMips ( [TArray](API\Runtime\Core\Containers\TArray)< [FImage](API\Runtime\ImageCore\FImage) > & InOutMipChain, int32 NumMips, uint32 DiffuseConvolveMipLevel )


description: Generates the base cubemap mip from a longitude-latitude 2D image.

code: static void GenerateBaseCubeMipFromLongitudeLatitude2D ( [FImage](API\Runtime\ImageCore\FImage) * OutMip, const [FImage](API\Runtime\ImageCore\FImage) & SrcImage, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings )


code: static void GenerateBaseCubeMipFromLongitudeLatitude2D ( [FImage](API\Runtime\ImageCore\FImage) * OutMip, const [FImage](API\Runtime\ImageCore\FImage) & SrcImage, const uint32 MaxCubemapTextureResolution, uint8 SourceEncodingOverride )


description: Generate a full mip chain. The input mip chain must have one or more mips.

code: static void GenerateMipChain ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & Settings, const [FImage](API\Runtime\ImageCore\FImage) & BaseImage, [TArray](API\Runtime\Core\Containers\TArray)< [FImage](API\Runtime\ImageCore\FImage) > & OutMipChain, uint32 MipChainDepth )


description: Returns the number of mips that the given texture will generate with the given build settings, as well as the size of the top mip. Used for physical textures - not virtual textures.

code: static int32 GetMipCountForBuildSettings ( int32 InMip0SizeX, int32 InMip0SizeY, int32 InMip0NumSlices, int32 InExistingMipCount, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, int32 & OutMip0SizeX, int32 & OutMip0SizeY, int32 & OutMip0NumSlices )


className: ITextureCompressorModule

description: Texture compression module interface.

code: class ITextureCompressorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: TextureFormat

code: void AddBaseTextureFormatModules ( const TCHAR * ModuleNameWildcard )


description: true in case Compress can handle other than RGBA32F image formats

code: virtual bool CanAcceptNonF32Source ( [FName](API\Runtime\Core\UObject\FName) Format ) const


code: bool CompressBaseImage ( const [FImage](API\Runtime\ImageCore\FImage) & InImage, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, const FIntVector3 & InMip0Dimensions, int32 InMip0NumSlicesNoDepth, int32 InMipIndex, int32 InMipCount, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) & OutCompressedImage ) const


code: bool CompressBaseImageTiled ( 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, [FCompressedImage2D](API\Developer\TextureCompressor\FCompressedImage2D) & OutCompressedImage ) const


description:
Obtains the global format config object for this texture format.
The global format config object or an empty object if no format settings are defined for this texture format.

code: virtual [FCbObject](API\Runtime\Core\Serialization\FCbObject) ExportGlobalChildFormatConfig ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings ) const


description:
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.

code: virtual [FCbObject](API\Runtime\Core\Serialization\FCbObject) ExportGlobalFormatConfig ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings ) const


code: [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) GetBaseFormatConfigOverride ( const [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) & ObjView ) const


code: [FName](API\Runtime\Core\UObject\FName) GetBaseFormatName ( [FName](API\Runtime\Core\UObject\FName) ChildFormatName ) const


description: Given a platform specific format name, get the texture format object that will do the encoding.

code: const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * GetBaseFormatObject ( [FName](API\Runtime\Core\UObject\FName) FormatName ) const


code: [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) GetBaseTextureBuildSettings ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings ) const


description: Make the child type think about if they need a key string or not, by making it pure virtual. InMipCount and InMip0Dimensions are only valid for non-virtual textures (VTs should never call this function as they never tile)

code: [FString](API\Runtime\Core\Containers\FString) GetChildDerivedDataKeyString ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, int32 InMipCount, const FIntVector3 & InMip0Dimensions ) const


code: virtual const [FChildTextureFormat](API\Developer\TextureFormat\FChildTextureFormat) * GetChildFormat() const


description: The final version is a combination of parent and child formats, 8 bits for each

code: uint8 GetChildFormatVersion ( [FName](API\Runtime\Core\UObject\FName) Format, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) * BuildSettings ) const


description:
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 "_"

code: virtual [FString](API\Runtime\Core\Containers\FString) GetDerivedDataKeyString ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, int32 InMipCount, const FIntVector3 & InMip0Dimensions ) const


description: 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.

code: virtual EPixelFormat GetEncodedPixelFormat ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, bool bInImageHasAlphaChannel ) const


description: Used for debugging and UI.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetEncoderName ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description:
Obtains the format config appropriate for the build .
The format settings object view or a null view if the active global format config should be used.

code: virtual [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) GetChildFormatConfigOverride ( const [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) & ObjView ) const


description: Gets the list of supported formats.

code: virtual void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description: 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.

code: virtual const [ITextureTiler](API\Developer\TextureFormat\Interfaces\ITextureTiler) * GetTiler() const


description:
Gets the current version of the specified texture format.
Version number.

code: virtual uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) * BuildSettings ) const


description:
Prepares to compresses a single image with tiling. The result OutTilerSettings is used by SetTiling and CompressImageTiled.
true on success, false otherwise.

code: 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


description: Cleans up the FTilerSettings object once it is finished.

code: 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


description:
Sets the tiling settings after device-specific tiling has been performed.
true on success, false otherwise.

code: 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


description: 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.

code: virtual bool SupportsEncodeSpeed ( [FName](API\Runtime\Core\UObject\FName) Format ) const


code: FChildTextureFormat ( const TCHAR * PlatformFormatPrefix )


className: GetTextureFormatManager

description: Return the Texture Format Manager interface, if it is available, otherwise return nullptr.


className: FChildTextureFormat

description: 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).

code: class FChildTextureFormat : public [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat)

BaseFormats

type: TArray<FName>

description: List of base formats that. Combined with FormatPrefix, this contains all formats this can handle.

FormatPrefix

type: constFString

description: Prefix put before all formats from parent formats.

SupportedFormatsCached

description: List of combined BaseFormats with FormatPrefix.


className: GetTextureFormatManagerRef

description: Return the Texture Format Manager interface, fatal error if it is not available.


description: Returns the descriptionfor the single mip level(i.e. no further mips)

code: [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) GetDescriptionForMipLevel ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 InMipIndex ) const


description: This handles mip chains whether or not they have packed mip tails. NoteGetNumEncodedMips()== OutMipTailIndex + 1

code: void GetEncodedMipIterators ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 & OutMipTailIndex, int32 & OutMipsInTail ) const


description: Always 1 unless volume texture.

code: int32 GetMipDepth ( int32 InMipIndex ) const


code: static int32 GetMipDepth ( int32 InTextureDepth, int32 InMipIndex, bool bInVolumeTexture )


description: Returns the size of the mip at the given index. Z is 1 unless it's a volume texture.

code: FIntVector3 GetMipDimensions ( int32 InMipIndex ) const


code: int32 GetMipHeight ( int32 InMipIndex ) const


code: static int32 GetMipHeight ( int32 InTextureHeight, int32 InMipIndex )


description: Returns the byte size of the unpacked/tiled mip. For mip chains that are packed or tiled, useFEncodedTextureExtendedData::MipSizesInBytes.

code: uint64 GetMipSizeInBytes ( int32 InMipIndex ) const


code: int32 GetMipWidth ( int32 InMipIndex ) const


code: static int32 GetMipWidth ( int32 InTextureWidth, int32 InMipIndex )


description: 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.

code: int32 GetNumEncodedMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData ) const


description: Returns the slice count for usage cases/platforms that expect slice count to only include cubemap/array slices.

code: int32 GetNumSlices_NoDepth() const


description: Returns the slice count for usage cases/platform that expect slice count to include volume texture depth. InMipIndex only affects volume textures.

code: int32 GetNumSlices_WithDepth ( int32 InMipIndex ) const


code: int32 GetNumStreamingMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, const [FTextureEngineParameters](API\Developer\TextureFormat\Interfaces\FTextureEngineParameters) & InEngineParameters ) const


code: bool operator== ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & OtherTextureDescription ) const


code: [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) RemoveTopMips ( const [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) * InExtendedData, int32 InRemoveCount ) const


className: FEncodedTextureDescription

description: 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.

code: struct FEncodedTextureDescription

PixelFormat

type: EPixelFormat


className: FEncodedTextureExtendedData

description: Extra data for an encoded texture. For "normal" textures (i.e. linear, without a packed mip tail), this must be all zeroes.

code: struct FEncodedTextureExtendedData

bSensitiveToLODBias

description: If true, this texture might change layouts if top mips are striped (i.e. LODBias is not zero).

LODBiasIfSensitive

description: If bSensitiveToLODBias is set, this is the LODBias for this layout.

MipSizesInBytes

type: TArray< uint64,...

description: With packing/tiling, mip sizes are not trivially computable.


className: FTextureEngineParameters

description: Created via GenerateTextureEngineParameters() in TextureDerivedDataTask.cpp.

code: struct FTextureEngineParameters


className: FTextureFormatCompressorCaps

description: Structure for texture format compressor capabilities. This struct is deprecated -FEncodedTextureExtendedDatais used instead.

code: struct FTextureFormatCompressorCaps


code: FTextureFormatCompressorCaps()


className: GetNumStreamingMipsDirect

description: 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()

code: 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 )


code: static bool GetStreamingDisabledForNonVirtualTextureProperties ( bool bInCubeMap, bool bInVolumeTexture, bool bInTextureArray, const [FTextureEngineParameters](API\Developer\TextureFormat\Interfaces\FTextureEngineParameters) & InEngineParameters )


description:
Checks whether this texture format can compress in parallel.
true if parallel compression is supported, false otherwise.

code: virtual bool AllowParallelBuild() const


description: true in case Compress can handle other than RGBA32F image formats

code: virtual bool CanAcceptNonF32Source ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description:
Compresses a single image.
true on success, false otherwise.

code: 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


description:
Compress an image (or images for a miptail) into a single mip blob.
true on success, false otherwise.

code: 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


description:
Compress an image (or images for a miptail) into a single mip blob with device-specific tiling.
true on success, false otherwise.

code: 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


description:
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.

code: virtual [FCbObject](API\Runtime\Core\Serialization\FCbObject) ExportGlobalFormatConfig ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings ) const


className: FTilerSettings

description: 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.

code: struct FTilerSettings


description: If this is an Alternate Texture Format, return the prefix to apply

code: virtual [FString](API\Runtime\Core\Containers\FString) GetAlternateTextureFormatPrefix() const


code: virtual const [FChildTextureFormat](API\Developer\TextureFormat\FChildTextureFormat) * GetChildFormat() const


description:
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 "_"

code: virtual [FString](API\Runtime\Core\Containers\FString) GetDerivedDataKeyString ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, int32 InMipCount, const FIntVector3 & InMip0Dimensions ) const


description: 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.

code: virtual EPixelFormat GetEncodedPixelFormat ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & InBuildSettings, bool bInImageHasAlphaChannel ) const


description: Used for debugging and UI.

code: [FName](API\Runtime\Core\UObject\FName) GetEncoderName ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description: 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.

code: virtual [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) GetExtendedDataForTexture ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & InTextureDescription, int8 InLODBias ) const


description: Gets the capabilities of the texture compressor.


code: 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


description: Identify the latest sdk version for this texture encoder (note the SdkVersion is different than the TextureFormat Version)

code: virtual [FName](API\Runtime\Core\UObject\FName) GetLatestSdkVersion() const


description: Calculate the final/runtime pixel format for this image on this platform

code: virtual EPixelFormat GetPixelFormatForImage ( const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) & BuildSettings, const struct [FImage](API\Runtime\ImageCore\FImage) & Image, bool bImageHasAlphaChannel ) const


description: Gets the list of supported formats.

code: void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutFormats ) const


description:
Gets the current version of the specified texture format.
Version number.

code: uint16 GetVersion ( [FName](API\Runtime\Core\UObject\FName) Format, const [FTextureBuildSettings](API\Developer\TextureCompressor\FTextureBuildSettings) * BuildSettings ) const


description:
Prepares to compresses a single image with tiling. The result OutTilerSettings is used by SetTiling and CompressImageTiled.
true on success, false otherwise.

code: 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


description: Cleans up theFTilerSettingsobject once it is finished.

code: 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


description:
Sets the tiling settings after device-specific tiling has been performed.
true on success, false otherwise.

code: 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


description: 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.

code: virtual bool SupportsEncodeSpeed ( [FName](API\Runtime\Core\UObject\FName) Format ) const


description:
Whether device-specific tiling is supported by the compressor.
true if tiling is supported, false if it must be done by the caller

code: virtual bool SupportsTiling() const


description: Deprecated* Legacy API - do not use

code: virtual bool UsesTaskGraph() const


description: Virtual destructor.

code: virtual ~ITextureFormat()


className: ITextureFormat

description: 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.

code: class ITextureFormat


description:
Finds a texture format with the specified name.
The texture format, or nullptr if not found.

code: const [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * FindTextureFormat ( [FName](API\Runtime\Core\UObject\FName) Name )


description:
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.

code: 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 )


description:
Returns the list of all ITextureFormats that were located in DLLs.
Collection of texture formats.

code: const [TArray](API\Runtime\Core\Containers\TArray)< const class [ITextureFormat](API\Developer\TextureFormat\Interfaces\ITextureFormat) * > & GetTextureFormats()


description: 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.

code: void Invalidate()


description: Virtual destructor.

code: ~ITextureFormatManagerModule()


description: Will this TextureFormat call back to Managermodule GetTextureFormats ?

code: bool CanCallGetTextureFormats()


description:
Gets the texture format.
The texture format interface.


description: Virtual destructor.

code: ~ITextureFormatModule()


className: ITextureFormatModule

description: Interface for texture format modules.

code: class ITextureFormatModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: 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.

code: [FEncodedTextureExtendedData](API\Developer\TextureFormat\Interfaces\FEncodedTextureExtendedData) GetExtendedDataForTexture ( const [FEncodedTextureDescription](API\Developer\TextureFormat\Interfaces\FEncodedTextureDescription) & InTextureDescription, int8 InLODBias ) const


description: 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.

code: [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


className: ITextureTiler

description: 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.

code: class ITextureTiler


className: ITextureFormatManagerModule

description: Module for the texture format manager

code: class ITextureFormatManagerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: const FUtf8StringView GetBuildFunctionName() const


className: EToolMenuInsertType

module: ToolMenus

code: enum EToolMenuInsertType { Default, Before, After, First, }


className: EToolMenuStringCommandType

code: enum EToolMenuStringCommandType { Command, Python, Custom, }


className: FGeneratedToolMenuWidget

code: struct FGeneratedToolMenuWidget

GeneratedMenu

type: TObjectPtr<UTo...

Widget

type: TWeakPtr<SWidg...


className: FGeneratedToolMenuWidgets

code: struct FGeneratedToolMenuWidgets

Instances

type: TArray<FGenera...


code: FNewSectionConstructChoice ( const [FNewToolMenuDelegate](API\Developer\ToolMenus\FNewToolMenuDelegate) & InNewToolMenuDelegate )


code: FNewSectionConstructChoice ( const [FNewToolMenuDelegateLegacy](API\Developer\ToolMenus\FNewToolMenuDelegateLegacy) & InNewToolMenuDelegateLegacy )


code: FNewSectionConstructChoice ( const [FNewToolBarDelegateLegacy](API\Developer\ToolMenus\FNewToolBarDelegateLegacy) & InNewToolBarDelegateLegacy )


className: FNewSectionConstructChoice

code: struct FNewSectionConstructChoice

NewToolBarDelegateLegacy

type: FNewToolBarDele...

NewToolMenuDelegate

type: FNewToolMenuDel...


className: FNewToolBarDelegateLegacy

code: typedef TBaseDelegate_TwoParams< void, class [FToolBarBuilder](API\Runtime\Slate\Framework\MultiBox\FToolBarBuilder) &, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolBarDelegateLegacy


code: FNewToolMenuChoice ( const FOnGetContent & InOnGetContent )


code: FNewToolMenuChoice ( const [FNewToolMenuWidget](API\Developer\ToolMenus\FNewToolMenuWidget) & InNewToolMenuWidget )


code: FNewToolMenuChoice ( const [FNewToolMenuDelegate](API\Developer\ToolMenus\FNewToolMenuDelegate) & InNewToolMenu )


code: FNewToolMenuChoice ( const FNewMenuDelegate & InNewMenuLegacy )


className: FNewToolMenuChoice

code: struct FNewToolMenuChoice

NewMenuLegacy

type: FNewMenuDelegat...

NewToolMenuWidget

type: FNewToolMenuWid...

OnGetContent

type: FOnGetContent


className: FNewToolMenuCustomWidget

code: 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


className: FNewToolMenuDelegate

code: typedef TBaseDelegate_OneParam< void, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolMenuDelegate


className: FNewToolMenuDelegateLegacy

code: typedef TBaseDelegate_TwoParams< void, class [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) &, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FNewToolMenuDelegateLegacy


className: FNewToolMenuSectionDelegate

code: typedef TBaseDelegate_OneParam< void, [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & > FNewToolMenuSectionDelegate


className: FNewToolMenuWidget

code: typedef TBaseDelegate_OneParam< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FNewToolMenuWidget


className: FScriptSlateIcon::operator FSlateIcon

code: operator FSlateIcon() const


code: FScriptSlateIcon ( const [FName](API\Runtime\Core\UObject\FName) InStyleSetName, const [FName](API\Runtime\Core\UObject\FName) InStyleName )


code: FScriptSlateIcon ( const [FName](API\Runtime\Core\UObject\FName) InStyleSetName, const [FName](API\Runtime\Core\UObject\FName) InStyleName, const [FName](API\Runtime\Core\UObject\FName) InSmallStyleName )


className: FScriptSlateIcon

code: struct FScriptSlateIcon

SmallStyleName

type: FName


className: FToolDynamicUIAction

code: struct FToolDynamicUIAction

CanExecuteAction

type: FToolMenuDynami...


className: FToolMenuCanExecuteAction

code: typedef TBaseDelegate_OneParam< bool, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuCanExecuteAction


code: void AddExtender ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > & InExtender )


code: void AddObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FContextObjectCleanup](API\Developer\ToolMenus\FToolMenuContext\FContextObjectCleanup) && InCleanup )


code: void AddObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject )


code: void AppendCommandList ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & InCommandList )


code: void AppendCommandList ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & InCommandList )


code: void AddCleanup ( [FContextCleanup](API\Developer\ToolMenus\FToolMenuContext\FContextCleanup) && InCleanup )


code: void AppendObjects ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InObjects )


className: FContextCleanup

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> FContextCleanup


className: FContextObjectCleanup

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([UObject](API\Runtime\CoreUObject\UObject\UObject) *)> FContextObjectCleanup


description: Deprecated* Find is deprecated. Use the FindContext instead.

code: template<typename TContextType> TContextType * Find() const


code: [UObject](API\Runtime\CoreUObject\UObject\UObject) * FindByClass ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass ) const


code: template<typename TContextType> TContextType * FindContext() const


code: const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) * GetActionForCommand ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > Command ) const


code: const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) * GetActionForCommand ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > Command, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & OutCommandList ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > GetAllExtenders() const


code: void SetIsEditing ( bool InIsEditing )


code: FToolMenuContext ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContext )


code: FToolMenuContext ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContext, [FContextObjectCleanup](API\Developer\ToolMenus\FToolMenuContext\FContextObjectCleanup) && InCleanup )


code: FToolMenuContext ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > InCommandList, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > InExtender, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContext )


className: FToolMenuContext

code: struct FToolMenuContext


className: FToolMenuCustomWidgetContext

code: struct FToolMenuCustomWidgetContext

StyleName

description: The name of the style used by the menu creating the widget.

StyleSet

type: constISlateSty...

description: The style used by the menu creating the widget.


className: FToolMenuDynamicCanExecuteAction

code: class FToolMenuDynamicCanExecuteAction


className: FToolMenuDynamicExecuteAction

code: class FToolMenuDynamicExecuteAction


className: FToolMenuDynamicGetActionCheckState


className: FToolMenuDynamicIsActionButtonVisible


className: FToolMenuDynamicIsActionChecked

code: class FToolMenuDynamicIsActionChecked


description: Deprecated* AddOptionsDropdown is deprecated. Use InitComboButton with bSimpleComboBox=true

code: void AddOptionsDropdown ( [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) InAction, const FOnGetContent InMenuContentGenerator, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip )


code: bool CommandAcceptsInput ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) const


code: void AddKeybindFromCommand ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand )


code: const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) * GetActionForCommand ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InContext, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & OutCommandList ) const


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitComboButton ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMenuContentGenerator, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, bool bInSimpleComboBox, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & Widget )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitMenuEntry ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, const [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > InNameOverride )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) InNameOverride, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const EUserInterfaceActionType UserInterfaceActionType, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitMenuEntryWithCommandList ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & InCommandList, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, const [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > InNameOverride )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitSeparator ( const [FName](API\Runtime\Core\UObject\FName) InName )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InWidget, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, bool bShouldCloseWindowAfterMenuSelection )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInOpenSubMenuOnClick, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const bool bShouldCloseWindowAfterMenuSelection )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, bool bInOpenSubMenuOnClick, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const bool bShouldCloseWindowAfterMenuSelection )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitToolBarButton ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, const [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > InNameOverride )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitToolBarButton ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const EUserInterfaceActionType UserInterfaceActionType, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: static [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) InitWidget ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InWidget, const [FText](API\Runtime\Core\Internationalization\FText) & Label, bool bNoIndent, bool bSearchable, bool bNoPadding, const [FText](API\Runtime\Core\Internationalization\FText) & InToolTipText )


code: bool IsCommandKeybindOnly() const


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & operator= ( const [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & operator= ( [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) && )


code: void SetCommandList ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & InCommandList )


code: bool TryExecuteToolUIAction ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InContext )


code: FToolMenuEntry ( const [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & )


code: FToolMenuEntry ( [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) && )


code: FToolMenuEntry ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) InOwner, const [FName](API\Runtime\Core\UObject\FName) InName, EMultiBlockType InType )


className: FToolMenuEntry

code: struct FToolMenuEntry

bShouldCloseWindowAfterMenuSelection

type: bool

Icon

type: TAttribute<FSl...

InsertPosition

type: FToolMenuInsert

Label

type: TAttribute<FTe...

MakeCustomWidget

type: FNewToolMenuCus...

description: Optional delegate that returns a widget to use as this menu entry

Owner

type: FToolMenuOwner

SubMenuData

type: FToolMenuEntryS...

ToolBarData

type: FToolMenuEntryT...

Type

type: EMultiBlockType

UserInterfaceActionType

type: EUserInterfaceA...

WidgetData

type: FToolMenuEntryW...


className: FToolMenuEntryOptionsDropdownData

Action

type: FUIAction

MenuContentGenerator

type: FNewToolMenuCho...


className: FToolMenuEntryScriptData

code: struct FToolMenuEntryScriptData

Icon

type: FScriptSlateIco...

Label

type: FText

OwnerName

description: Optional identifier used for unregistering a group of menu items.


code: FToolMenuEntryScriptDataAdvanced()


className: FToolMenuEntryScriptDataAdvanced

code: struct FToolMenuEntryScriptDataAdvanced

StyleNameOverride

type: FName


className: FToolMenuEntrySubMenuData

code: struct FToolMenuEntrySubMenuData

bAutoCollapse

description: Entry placed into the parent's menu when there is only one entry


className: FToolMenuEntryToolBarData

code: struct FToolMenuEntryToolBarData

bForceSmallIcons

description: Whether this toolbar should always use small icons, regardless of the current settings

bIsFocusable

description: Whether ToolBar will have Focusable buttons

ComboButtonContextMenuGenerator

description: Delegate that generates a widget for this combo button's menu content.

ConstructLegacy

type: FNewToolBarDele...

description: Legacy delegate that generates a widget for this combo button's menu content.

OptionsDropdownData

type: TSharedPtr<FTo...


className: FToolMenuEntryWidgetData

code: struct FToolMenuEntryWidgetData

bNoIndent

type: bool

description: Remove the padding from the left of the widget that lines it up with other menu items

bNoPadding

description: If true, no padding will be added

bSearchable

description: If true, widget will be searchable


className: FToolMenuExecuteAction

code: typedef TBaseDelegate_OneParam< void, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuExecuteAction


className: FToolMenuExecuteString

code: typedef TBaseDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuExecuteString


className: FToolMenuGetActionCheckState

code: typedef TBaseDelegate_OneParam< ECheckBoxState, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuGetActionCheckState


code: bool operator== ( const [FToolMenuInsert](API\Developer\ToolMenus\FToolMenuInsert) & Other ) const


code: bool operator!= ( const [FToolMenuInsert](API\Developer\ToolMenus\FToolMenuInsert) & Other ) const


code: FToolMenuInsert ( [FName](API\Runtime\Core\UObject\FName) InName, [EToolMenuInsertType](API\Developer\ToolMenus\EToolMenuInsertType) InPosition )


className: FToolMenuInsert

code: struct FToolMenuInsert

Name

description: Where to insert.

Position

type: EToolMenuInsert...

description: How to insert.


className: FToolMenuIsActionChecked

code: typedef TBaseDelegate_OneParam< bool, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuIsActionChecked


className: FToolMenuIsActionButtonVisible

code: typedef TBaseDelegate_OneParam< bool, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & > FToolMenuIsActionButtonVisible


className: EValueType

code: enum EValueType { None, Pointer, Name, }


code: bool operator== ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) & Other ) const


code: bool operator!= ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) & Other ) const


code: FToolMenuOwner ( void * InPointer )


code: FToolMenuOwner ( const WIDECHAR * InValue )


code: FToolMenuOwner ( const ANSICHAR * InValue )


code: FToolMenuOwner ( const [FName](API\Runtime\Core\UObject\FName) InValue )


className: FToolMenuOwner

code: struct FToolMenuOwner

ValueName

type: FStoreName


code: FToolMenuOwnerScoped ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) InOwner )


className: FToolMenuOwnerScoped

code: struct FToolMenuOwnerScoped


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddDynamicEntry ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FNewToolMenuSectionDelegate](API\Developer\ToolMenus\FNewToolMenuSectionDelegate) & InConstruct )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddDynamicEntry ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FNewToolMenuDelegateLegacy](API\Developer\ToolMenus\FNewToolMenuDelegateLegacy) & InConstruct )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddEntry ( const [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & Args )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddEntryObject ( [UToolMenuEntryScript](API\Developer\ToolMenus\UToolMenuEntryScript) * InObject )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddMenuEntry ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, const [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > InNameOverride )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) InNameOverride, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const EUserInterfaceActionType UserInterfaceActionType, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddMenuEntryWithCommandList ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & InCommandList, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIconOverride, const [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, const [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > InNameOverride )


description: Deprecated* AddMenuSeparator has been deprecated. Use AddSeparator instead.

code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddMenuSeparator ( const [FName](API\Runtime\Core\UObject\FName) InName )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddSeparator ( const [FName](API\Runtime\Core\UObject\FName) InName )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InWidget, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, bool bShouldCloseWindowAfterMenuSelection )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, bool bInOpenSubMenuOnClick, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const bool bShouldCloseWindowAfterMenuSelection )


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & AddSubMenu ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [FNewToolMenuChoice](API\Developer\ToolMenus\FNewToolMenuChoice) & InMakeMenu, const [FToolUIActionChoice](API\Developer\ToolMenus\FToolUIActionChoice) & InAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInOpenSubMenuOnClick, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) > & InIcon, const bool bShouldCloseWindowAfterMenuSelection )


code: template<typename TContextType> TContextType * FindContext() const


code: [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) * FindEntry ( const [FName](API\Runtime\Core\UObject\FName) InName )


code: const [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) * FindEntry ( const [FName](API\Runtime\Core\UObject\FName) InName ) const


code: void InitSection ( const [FName](API\Runtime\Core\UObject\FName) InName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [FToolMenuInsert](API\Developer\ToolMenus\FToolMenuInsert) InPosition )


className: FToolMenuSection

code: struct FToolMenuSection

Blocks

type: TArray<FToolMe...

Construct

type: FNewSectionCons...

Context

type: FToolMenuContex...

InsertPosition

type: FToolMenuInsert

Label

type: TAttribute<FTe...

ToolMenuSectionDynamic

type: TObjectPtr<UTo...


code: FToolMenuStringCommand ( [EToolMenuStringCommandType](API\Developer\ToolMenus\EToolMenuStringCommandType) InType, [FName](API\Runtime\Core\UObject\FName) InCustomType, const [FString](API\Runtime\Core\Containers\FString) & InString )


className: FToolMenuStringCommand

code: struct FToolMenuStringCommand

CustomType

description: Which command handler to use when type is custom.

String

type: FString

description: String to pass to command handler.

Type

type: EToolMenuString...

description: Which command handler to use.


code: FToolUIAction ( const [FToolMenuExecuteAction](API\Developer\ToolMenus\FToolMenuExecuteAction) & InExecuteAction )


className: FToolUIAction

code: struct FToolUIAction

CanExecuteAction

type: FToolMenuCanExe...

ExecuteAction

type: FToolMenuExecut...

GetActionCheckState

type: FToolMenuGetAct...

IsActionVisibleDelegate

type: FToolMenuIsActi...


code: const [FToolUIAction](API\Developer\ToolMenus\FToolUIAction) * GetToolUIAction() const


code: const [FToolDynamicUIAction](API\Developer\ToolMenus\FToolDynamicUIAction) * GetToolDynamicUIAction() const


code: const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) * GetUIAction() const


code: FToolUIActionChoice ( const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & InAction )


code: FToolUIActionChoice ( const FExecuteAction & InExecuteAction )


code: FToolUIActionChoice ( const [FToolUIAction](API\Developer\ToolMenus\FToolUIAction) & InAction )


code: FToolUIActionChoice ( const [FToolDynamicUIAction](API\Developer\ToolMenus\FToolDynamicUIAction) & InAction )


code: FToolUIActionChoice ( const [FToolMenuExecuteAction](API\Developer\ToolMenus\FToolMenuExecuteAction) & InExecuteAction )


code: FToolUIActionChoice ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > & InCommand, const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) & InCommandList )


className: FToolUIActionChoice

code: struct FToolUIActionChoice


description: Retrieve the module instance.

code: static [IToolMenusModule](API\Developer\ToolMenus\IToolMenusModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IToolMenusModule

code: class IToolMenusModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: USlateTabManagerContext

code: class USlateTabManagerContext : public [UToolMenuContextBase](API\Developer\ToolMenus\UToolMenuContextBase)

TabManager

type: TWeakPtr<FTabM...


code: void AddDynamicSectionScript ( const [FName](API\Runtime\Core\UObject\FName) SectionName, [UToolMenuSectionDynamic](API\Developer\ToolMenus\UToolMenuSectionDynamic) * Object )


description: Callback is passed sandboxed empty menu to add as many sections as desired. Sections merged into the final menu afterwards.

code: [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & AddDynamicSection ( const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FNewSectionConstructChoice](API\Developer\ToolMenus\FNewSectionConstructChoice) & InConstruct, const [FToolMenuInsert](API\Developer\ToolMenus\FToolMenuInsert) InPosition )


code: virtual [FCustomizedToolMenu](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenu) * AddMenuCustomization() const


code: void AddMenuEntry ( const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FToolMenuEntry](API\Developer\ToolMenus\FToolMenuEntry) & Args )


code: void AddMenuEntryObject ( [UToolMenuEntryScript](API\Developer\ToolMenus\UToolMenuEntryScript) * InObject )


code: [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & AddSection ( const [FName](API\Runtime\Core\UObject\FName) SectionName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [FToolMenuInsert](API\Developer\ToolMenus\FToolMenuInsert) InPosition )


code: void AddSectionScript ( const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FText](API\Runtime\Core\Internationalization\FText) & Label, const [FName](API\Runtime\Core\UObject\FName) InsertName, const [EToolMenuInsertType](API\Developer\ToolMenus\EToolMenuInsertType) InsertType )


code: [UToolMenu](API\Developer\ToolMenus\UToolMenu) * AddSubMenu ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) Owner, const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FName](API\Runtime\Core\UObject\FName) Name, const [FText](API\Runtime\Core\Internationalization\FText) & Label, const [FText](API\Runtime\Core\Internationalization\FText) & ToolTip )


code: [UToolMenu](API\Developer\ToolMenus\UToolMenu) * AddSubMenuScript ( const [FName](API\Runtime\Core\UObject\FName) Owner, const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FName](API\Runtime\Core\UObject\FName) Name, const [FText](API\Runtime\Core\Internationalization\FText) & Label, const [FText](API\Runtime\Core\Internationalization\FText) & ToolTip )


code: virtual bool ContainsEntry ( const [FName](API\Runtime\Core\UObject\FName) InName ) const


code: virtual bool ContainsSection ( const [FName](API\Runtime\Core\UObject\FName) InName ) const


code: template<typename TContextType> TContextType * FindContext() const


code: virtual [FCustomizedToolMenu](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenu) * FindMenuCustomization() const


code: [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & FindOrAddSection ( const [FName](API\Runtime\Core\UObject\FName) SectionName )


code: [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) * FindSection ( const [FName](API\Runtime\Core\UObject\FName) SectionName )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetMenuHierarchyNames ( bool bIncludeSubMenuRoot ) const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetSectionName ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const


description: Returns array [Menu, Menu.SubMenuA, Menu.SubMenuB] for Menu.SubMenuB.SubMenuB

code: [TArray](API\Runtime\Core\Containers\TArray)< const [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > GetSubMenuChain() const


description: Returns "SubMenuC.SubMenuD" for menu "ModuleA.MenuB.SubMenuC.SubMenuD"


code: void InitMenu ( const [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) Owner, [FName](API\Runtime\Core\UObject\FName) Name, [FName](API\Runtime\Core\UObject\FName) Parent, EMultiBoxType Type )


code: [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


code: void RemoveSection ( const [FName](API\Runtime\Core\UObject\FName) SectionName )


description: Set support for extenders

code: void SetExtendersEnabled ( bool bEnabled )


code: void SetMaxHeight ( uint32 InMaxHeight )


code: virtual void UpdateMenuCustomizationFromMultibox ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FMultiBox](API\Runtime\Slate\Framework\MultiBox\FMultiBox) > & InMultiBox )


className: UToolMenu

code: class UToolMenu : public [UToolMenuBase](API\Runtime\Slate\Framework\MultiBox\UToolMenuBase)

bPreventCustomization

description: Prevent menu from being customized

MenuName

type: FName

MenuOwner

type: FToolMenuOwner

MenuType

type: EMultiBoxType

SubMenuParent

type: TObjectPtr< con...


className: UToolMenuContextBase

code: class UToolMenuContextBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: bool CanExecute ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: virtual bool CanExecute_Implementation ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: void ConstructMenuEntry ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * Menu, const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context )


code: void Execute ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context )


code: ECheckBoxState GetCheckState ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: virtual [FScriptSlateIcon](API\Developer\ToolMenus\FScriptSlateIcon) GetIcon_Implementation ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: static [UToolMenuEntryScript](API\Developer\ToolMenus\UToolMenuEntryScript) * GetIfCanSafelyRouteCall ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UToolMenuEntryScript](API\Developer\ToolMenus\UToolMenuEntryScript) > & InWeak )


code: [FScriptSlateIcon](API\Developer\ToolMenus\FScriptSlateIcon) GetIcon ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: [FText](API\Runtime\Core\Internationalization\FText) GetLabel ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetLabel_Implementation ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: [FText](API\Runtime\Core\Internationalization\FText) GetToolTip ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const


code: virtual ECheckBoxState GetCheckState_Implementation ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context ) const