description: Takes the file at the provided path and uses the metadata to find and compare it with a ground truth version.TFuture

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FImageComparisonResult](API\Developer\ScreenShotComparisonTools\FImageComparisonResult) > CompareScreenshotAsync ( const [FString](API\Runtime\Core\Containers\FString) & IncomingPath, const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & MetaData, const [EScreenShotCompareOptions](API\Developer\ScreenShotComparisonTools\Interfaces\EScreenShotCompareOptions) Options )


description: Exports target screenshot report to the export location specified

module: ScreenShotComparisonTools

code: [FScreenshotExportResult](API\Developer\ScreenShotComparisonTools\Interfaces\FScreenshotExportResult) ExportScreenshotComparisonResult ( [FString](API\Runtime\Core\Containers\FString) ScreenshotName, [FString](API\Runtime\Core\Containers\FString) ExportPath, bool bOnlyIncoming )


description: Calculate the ideal path for already already approved (ground truth) images. This handles abstracting away where Ground Truth images should be saved based on the platform/rhi/etc.

code: [FString](API\Runtime\Core\Containers\FString) GetIdealApprovedFolderForImage ( const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & MetaData ) const


description: Imports screenshot comparison data from a given path.

code: bool OpenComparisonReports ( [FString](API\Runtime\Core\Containers\FString) ImportPath, [TArray](API\Runtime\Core\Containers\TArray)< [FComparisonReport](API\Developer\ScreenShotComparisonTools\FComparisonReport) > & OutReports )


code: virtual ~IScreenShotManager()


className: IScreenShotManager

description: Interface that defines a class which is capable of comparing screenshots at a provided path with checked in ground truth versions and generate results and reports.

code: class IScreenShotManager


className: IScreenShotManagerPtr

description: Type definition for shared pointers to instances ofIScreenShotManager.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IScreenShotManager](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManager) > IScreenShotManagerPtr


className: IScreenShotManagerRef

description: Type definition for shared references to instances ofIScreenShotManager.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IScreenShotManager](API\Developer\ScreenShotComparisonTools\Interfaces\IScreenShotManager) > IScreenShotManagerRef


description:
Get the session manager.
The session manager.


description: Virtual destructor.

code: virtual ~IScreenShotToolsModule()


className: IScreenShotToolsModule

description: Interface for session core modules.

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


description: Creates class instance

code: static [UScreenShotComparisonSettings](API\Developer\ScreenShotComparisonTools\UScreenShotComparisonSettings) * Create ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


code: static const [TSet](API\Runtime\Core\Containers\TSet)< [FScreenshotFallbackEntry](API\Developer\ScreenShotComparisonTools\FScreenshotFallbackEntry) > & GetAllPlatformSettings()


description: Returns platform name reference. As the class can store platform-independent config, it returns an empty string if the platform was not specified.

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


description: Overrides config hierarchy platform to be used inUObjectinternals

code: virtual const TCHAR * GetConfigOverridePlatform() const


description: Loads settings of corresponding config.

code: virtual void LoadSettings()


description: Sets platform and reloads settings.

code: virtual void SetPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


code: UScreenShotComparisonSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UScreenShotComparisonSettings

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

type: bool

description: If true, any checked-in test results for confidential platforms will be put under/Platforms//Test instead of/Test

ScreenshotFallbackPlatforms

type: TArray<FScreen...

description: An array of entries that describe other platforms we can use for fallbacks when comparing screenshots


description: Disassemble all functions in any classes that have matching names.

module: ScriptDisassembler

code: static void DisassembleAllFunctionsInClasses ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, const [FString](API\Runtime\Core\Containers\FString) & ClassnameSubstring )


description: Disassemble all of the script code in a single structure.

code: void DisassembleStructure ( [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * Source )


description: Construct a disassembler that will output to the specified archive.

code: FKismetBytecodeDisassembler ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & InAr )


className: FKismetBytecodeDisassembler

description: Kismet bytecode disassembler; Can be used to create a human readable version of Kismet bytecode for a specified structure or class.

code: class FKismetBytecodeDisassembler


description:
Creates a session browser widget.
The new session browser widget.

module: SessionFrontend

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateSessionBrowser ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISessionManager](API\Runtime\SessionServices\ISessionManager) > & SessionManager )


description: Show the session frontend tab.

code: void InvokeSessionFrontend ( [FName](API\Runtime\Core\UObject\FName) SubTabToActivate )


description: Creates a session console widget.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateSessionConsole ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISessionManager](API\Runtime\SessionServices\ISessionManager) > & SessionManager )


description: Virtual destructor.

code: virtual ~ISessionFrontendModule()


className: ISessionFrontendModule

description: Interface for launcher UI modules.

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


description: Adds items for this session in the tree.

code: void AddInstanceItemToTree ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FSessionBrowserTreeItem > & SessionItem, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FSessionBrowserTreeItem > & InstanceItem, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISessionInstanceInfo](API\Runtime\SessionServices\ISessionInstanceInfo) > & InstanceInfo )


description: Construct this widget.

code: void Construct ( const [FArguments](API\Developer\SessionFrontend\Widgets\Browser\SSessionBrowser\FArguments) & InArgs, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISessionManager](API\Runtime\SessionServices\ISessionManager) > InSessionManager )


description: Fully expands the specified tree view item.

code: void ExpandItem ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FSessionBrowserTreeItem > & Item )


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SSessionBrowser >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Filters the session tree.

code: void FilterSessions()


description: Reloads the sessions list.

code: void ReloadSessions()


description: Destructor.

code: ~SSessionBrowser()


className: SSessionBrowser

description: Implements a Slate widget for browsing active game sessions.

code: class SSessionBrowser : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description:
Gets the category's localized description text.
Description text.

module: Settings

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


description:
Gets the category's localized display name.
Display name.

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDisplayName() const


description:
Gets the category's name.
Category name.

code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


description:
Gets the settings section with the specified name.
The settings section, or nullptr if it doesn't exist.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > GetSection ( const [FName](API\Runtime\Core\UObject\FName) & SectionName, bool bIgnoreVisibility ) const


description:
Gets the setting sections contained in this category.
The number of sections returned.

code: int32 GetSections ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) >> & OutSections, bool bIgnoreVisibility ) const


description: Virtual destructor.

code: virtual ~ISettingsCategory()


className: ISettingsCategory

description: A setting category is a collection of setting sections that logically belong together (i.e. all project settings or all platform settings). Each section then contains the actual settings in the form ofUObjectproperties.

code: class ISettingsCategory


className: ISettingsCategoryPtr

description: Type definition for shared pointers to instances ofISettingsCategory.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsCategory](API\Developer\Settings\ISettingsCategory) > ISettingsCategoryPtr


className: ISettingsCategoryRef

description: Type definition for shared references to instances ofISettingsCategory.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsCategory](API\Developer\Settings\ISettingsCategory) > ISettingsCategoryRef


description: Updates the details of this settings container.

code: void Describe ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & InDescription, const [FName](API\Runtime\Core\UObject\FName) & InIconName )


description: Updates the details of the specified settings category.

code: void DescribeCategory ( const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & Description )


className: FOnCategoryModified

description: A delegate that is executed when a settings category has been added or modified.

code: typedef TMulticastDelegate_OneParam< void, const [FName](API\Runtime\Core\UObject\FName) & > FOnCategoryModified


className: FOnSectionRemoved

description: A delegate that is executed when a settings section has been removed.

code: typedef TMulticastDelegate_OneParam< void, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > & > FOnSectionRemoved


description:
Gets the setting categories.
The number of categories returned.

code: int32 GetCategories ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsCategory](API\Developer\Settings\ISettingsCategory) >> & OutCategories ) const


description:
Gets the category with the specified name.
The category, or nullptr if it doesn't exist.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsCategory](API\Developer\Settings\ISettingsCategory) > GetCategory ( const [FName](API\Runtime\Core\UObject\FName) & CategoryName ) const


description:
Gets the container's localized description text.
Description text.


description:
Gets the container's localized display name.
Display name.


description:
Gets the container's name.
Container name.


description:
Gets the name of the container's icon.
Icon image name.

code: const [FName](API\Runtime\Core\UObject\FName) & GetIconName() const


description: Sort priority

code: void ResetCategorySortPriority ( [FName](API\Runtime\Core\UObject\FName) CategoryName )


description: A category named "Advanced" has a priority of 1.0 by default

code: void SetCategorySortPriority ( [FName](API\Runtime\Core\UObject\FName) CategoryName, float Priority )


description: Virtual destructor.

code: virtual ~ISettingsContainer()


className: ISettingsContainer

description: A settings container is a collection of setting categories. Each category holds a collection of setting sections, which contain the actual settings in the form ofUObjectproperties.

code: class ISettingsContainer


className: ISettingsContainerPtr

description: Type definition for shared pointers to instances ofISettingsContainer.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsContainer](API\Developer\Settings\ISettingsContainer) > ISettingsContainerPtr


description:
Gets the global settings container with the specified name.
The settings container, or nullptr if it doesn't exist.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsContainer](API\Developer\Settings\ISettingsContainer) > GetContainer ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName )


className: ISettingsContainerRef

description: Type definition for shared references to instances ofISettingsContainer.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsContainer](API\Developer\Settings\ISettingsContainer) > ISettingsContainerRef


description: Gets the names of all known setting containers.

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


description:
If a section with the specified settings objects already exists, the existing section will be replaced.
The added settings section, or nullptr if the category does not exist.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > RegisterSettings ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName, const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FName](API\Runtime\Core\UObject\FName) & SectionName, const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & Description, const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & SettingsObject )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > RegisterSettings ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName, const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FName](API\Runtime\Core\UObject\FName) & SectionName, const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & Description, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & CustomWidget )


description: Registers a viewer for the specified settings container.

code: void RegisterViewer ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName, [ISettingsViewer](API\Developer\Settings\ISettingsViewer) & SettingsViewer )


description: Shows the settings viewer for the specified settings container.

code: void ShowViewer ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName, const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FName](API\Runtime\Core\UObject\FName) & SectionName )


description: Removes a settings section from the specified settings container.

code: void UnregisterSettings ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName, const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FName](API\Runtime\Core\UObject\FName) & SectionName )


description: Unregisters the currently assigned viewer for the specified settings container.

code: void UnregisterViewer ( const [FName](API\Runtime\Core\UObject\FName) & ContainerName )


description: Virtual destructor.

code: virtual ~ISettingsModule()


className: ISettingsModule

description: Interface for settings UI modules.

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


description:
Checks whether this section can be edited right now.
true if the section can be edited, false otherwise.

code: bool CanEdit() const


description:
Checks whether this section can export its settings to a file.
true if file export is supported, false otherwise.

code: bool CanExport() const


description:
Checks whether this section can import its settings from a file.
true if file import is supported, false otherwise.

code: bool CanImport() const


description:
Checks whether this section can have its settings reset to default.
true if resetting to default is supported, false otherwise.

code: bool CanResetDefaults() const


description:
This method does not indicate whether saving would actually succeed. For example, saving may be aborted by a ModifiedDelegate handler.
true if saving is supported, false otherwise.

code: bool CanSave() const


description:
Checks whether this section can have its settings saved as default.
true if saving as default is supported, false otherwise.

code: bool CanSaveDefaults() const


description:
Exports the settings in this section to the specified file.
true if the settings were exported, false otherwise.

code: bool Export ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


className: FOnCanEdit

description: The return value indicates whether the section can be edited.

code: typedef TBaseDelegate_NoParams< bool > FOnCanEdit


className: FOnExport

description: The first parameter is the path to the file to export to. The return value indicates whether exporting succeeded.

code: typedef TBaseDelegate_OneParam< bool, const [FString](API\Runtime\Core\Containers\FString) & > FOnExport


className: FOnImport

description: The first parameter is the path to the file to import from. The return value indicates whether importing succeeded.

code: typedef TBaseDelegate_OneParam< bool, const [FString](API\Runtime\Core\Containers\FString) & > FOnImport


className: FOnModified

description: The return value indicates whether the modifications should be saved.

code: typedef TBaseDelegate_NoParams< bool > FOnModified


className: FOnSave

description: The return value indicates whether saving succeeded.

code: typedef TBaseDelegate_NoParams< bool > FOnSave


className: FOnResetDefaults

description: The return value indicates whether resetting to defaults succeeded.

code: typedef TBaseDelegate_NoParams< bool > FOnResetDefaults


className: FOnSaveDefaults

description: The return value indicates whether saving as default succeeded.

code: typedef TBaseDelegate_NoParams< bool > FOnSaveDefaults


className: FOnSelect

description: A delegate that is executed to check whether a settings section can be edited.

code: typedef TBaseDelegate_NoParams< void > FOnSelect


className: FOnStatus

description: The return value is status message.

code: typedef TBaseDelegate_NoParams< [FText](API\Runtime\Core\Internationalization\FText) > FOnStatus


description:
Gets the settings category that this section belongs to.
The owner category.


description:
Gets the custom settings widget for this settings section.
The custom widget.

code: [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetCustomWidget() const


description:
Gets the section's name.
Section name.

code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


description:
Gets the section's localized description text.
Description text.

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


description:
Gets the section's localized display name.
Display name.

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDisplayName() const


description:
Gets theUObjectholding the section's settings.
Settings object.

code: [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > GetSettingsObject() const


description:
Gets the section's optional status text.
Status text.


description:
Checks whether this section holds a settings object that saves directly to default configuration files.
true if it has a default settings object, false otherwise.

code: bool HasDefaultSettingsObject()


description:
Imports the settings in this section from the specified file.
true if the settings were imported, false otherwise.

code: bool Import ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Notifies a section that a single property has been modified
true if settings should be saved, false otherwise.

code: bool NotifySectionOnPropertyModified()


description:
Resets the settings in this section to their default value.
true if the section was reset, false otherwise.

code: bool ResetDefaults()


description:
Saves the settings in this section.
true if settings were saved, false otherwise.

code: bool Save()


description:
Saves the settings in this section as defaults.
true if settings were saved, false otherwise.

code: bool SaveDefaults()


description: Called when the current section is selected.

code: void Select()


description: Virtual destructor.

code: virtual ~ISettingsSection()


className: ISettingsSection

description: A setting section is a collection of settings that logically belong together (i.e. all settings for a console platform). Internally, the individual settings are represented as the properties of anUObject. One or more setting sections can the be hierarchically arranged in a setting category.

code: class ISettingsSection


className: ISettingsSectionPtr

description: Type definition for shared pointers to instances ofISettingsSection.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > ISettingsSectionPtr


className: ISettingsSectionRef

description: Type definition for shared references to instances ofISettingsSection.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > ISettingsSectionRef


description: Shows the settings tab that belongs to this viewer with the specified settings section pre-selected.

code: void ShowSettings ( const [FName](API\Runtime\Core\UObject\FName) & CategoryName, const [FName](API\Runtime\Core\UObject\FName) & SectionName )


description: Virtual destructor.

code: virtual ~ISettingsViewer()


className: ISettingsViewer

description: Interface for settings tabs.

code: class ISettingsViewer


description:
Gets the section interface for a specified section object
The section interface for the section object or nullptr if it does not exist

module: SettingsEditor

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > GetSectionFromSectionObject ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * SectionObject ) const


description:
Gets the selected settings section.
The selected section, if any.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > & GetSelectedSection() const


description:
Gets the settings container.
The settings container.

code: const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsContainer](API\Developer\Settings\ISettingsContainer) > & GetSettingsContainer() const


description:
Returns a delegate that is executed when the selected settings section has changed.
The delegate.


description: SelectPreviousSection

code: void SelectSection ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsSection](API\Developer\Settings\ISettingsSection) > & Section )


description: Virtual destructor.

code: virtual ~ISettingsEditorModel()


className: ISettingsEditorModel

description: The settings editor view model stores the view state for the Settings Editor UI. Instances of this interface can be passed to Settings Editors in order to provide access to the settings container being added and to perform various user actions, such as setting the currently selected settings section.

code: class ISettingsEditorModel


className: ISettingsEditorModelPtr

description: Type definition for shared pointers to instances ofISettingsEditorModel.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISettingsEditorModel](API\Developer\SettingsEditor\ISettingsEditorModel) > ISettingsEditorModelPtr


className: ISettingsEditorModelRef

description: Type definition for shared references to instances ofISettingsEditorModel.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsEditorModel](API\Developer\SettingsEditor\ISettingsEditorModel) > ISettingsEditorModelRef


description: CreateModel

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateEditor ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsEditorModel](API\Developer\SettingsEditor\ISettingsEditorModel) > & Model )


description: CreateEditor

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsEditorModel](API\Developer\SettingsEditor\ISettingsEditorModel) > CreateModel ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISettingsContainer](API\Developer\Settings\ISettingsContainer) > & SettingsContainer )


description: Called when the settings have been changed such that an application restart is required for them to be fully applied

code: void OnApplicationRestartRequired()


description: Set the delegate that should be called when a setting editor needs to restart the application

code: void SetRestartApplicationCallback ( FSimpleDelegate InRestartApplicationDelegate )


description: Virtual destructor.

code: virtual ~ISettingsEditorModule()


className: ISettingsEditorModule

description: Interface for settings editor modules.

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


description: Adds a note to CompilerOutput.Error about where the shader parameter structure is on C++ side.

module: ShaderCompilerCommon

code: void AddNoteToDisplayShaderParameterStructureOnCppSide ( const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * ParametersStructure, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: AddUnboundShaderParameterError

description: Adds an error to CompilerOutput.Error about a shader parameters that could not be bound.

code: void AddUnboundShaderParameterError ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & CompilerInput, const [FShaderParameterParser](API\Runtime\RenderCore\FShaderParameterParser) & ShaderParameterParser, const [FString](API\Runtime\Core\Containers\FString) & ParameterBindingName, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: BuildResourceTableMapping

description: Deprecated* No longer supported; use version of function that accepts aFShaderResourceTableMapinstead

code: PRAGMA_DISABLE_DEPRECATION_WARNINGSbool BuildResourceTableMapping ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), FResourceTableEntry > & ResourceTableMap, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FUniformBufferEntry](API\Runtime\RenderCore\FUniformBufferEntry) > & UniformBufferMap, [TBitArray](API\Runtime\Core\Containers\TBitArray)<> & UsedUniformBufferSlots, [FShaderParameterMap](API\Runtime\RenderCore\FShaderParameterMap) & ParameterMap, [FShaderCompilerResourceTable](API\Runtime\RenderCore\FShaderCompilerResourceTable) & OutSRT )


description: This function looks for resources specified in ResourceTableMap in the parameter map, adds them to the resource table, and removes them from the parameter map. If a resource is used from a currently unmapped uniform buffer we allocate a slot for it from UsedUniformBufferSlots. Returns false if there's any internal error.

code: bool BuildResourceTableMapping ( const [FShaderResourceTableMap](API\Runtime\RenderCore\FShaderResourceTableMap) & ResourceTableMap, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FUniformBufferEntry](API\Runtime\RenderCore\FUniformBufferEntry) > & UniformBufferMap, [TBitArray](API\Runtime\Core\Containers\TBitArray)<> & UsedUniformBufferSlots, [FShaderParameterMap](API\Runtime\RenderCore\FShaderParameterMap) & ParameterMap, [FShaderCompilerResourceTable](API\Runtime\RenderCore\FShaderCompilerResourceTable) & OutSRT )


className: BuildResourceTableTokenStream

description: Builds a token stream out of the resource map. The resource map is one of the arrays generated by BuildResourceTableMapping. The token stream is used at runtime to gather resources from tables and bind them to the appropriate slots.

code: void BuildResourceTableTokenStream ( const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & InResourceMap, int32 MaxBoundResourceTable, [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & OutTokenStream, bool bGenerateEmptyTokenStreamIfNoResources )


className: CompileOfflineMali

description: Calls 'Mali Offline Compiler' to compile the glsl source code and extract the generated instruction count

code: void CompileOfflineMali ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & ShaderOutput, const ANSICHAR * ShaderSource, const int32 SourceSize, bool bVulkanSpirV, const ANSICHAR * VulkanSpirVEntryPoint )


code: bool ConvertFromFP32ToFP16 ( [FString](API\Runtime\Core\Containers\FString) & InOutSourceCode, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutErrors )


description: Intermediate representation languages for ShaderConductor disassembly output.

code: namespace CrossCompiler { enum EShaderConductorIR { Spirv, Dxil, } }


description: Target high level languages for ShaderConductor output.

code: namespace CrossCompiler { enum EShaderConductorLanguage { Hlsl, Glsl, Essl, Metal_macOS, Metal_iOS, } }


code: namespace CrossCompiler { bool CrossCompiler::Match ( const ANSICHAR *& Str, ANSICHAR Char ) }


code: namespace CrossCompiler { bool CrossCompiler::Match ( const TCHAR *& Str, ANSICHAR Char ) }


code: namespace CrossCompiler { bool CrossCompiler::Match ( const ANSICHAR *& Str, const ANSICHAR * Sub ) }


code: namespace CrossCompiler { bool CrossCompiler::Match ( const TCHAR *& Str, const TCHAR * Sub ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseIdentifier ( const ANSICHAR *& Str, [FString](API\Runtime\Core\Containers\FString) & OutStr ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseIdentifier ( const TCHAR *& Str, [FString](API\Runtime\Core\Containers\FString) & OutStr ) }


code: namespace CrossCompiler { template<typename T> bool CrossCompiler::ParseIntegerNumber ( const ANSICHAR *& Str, T & OutNum ) }


code: namespace CrossCompiler { template<typename T> bool CrossCompiler::ParseIntegerNumber ( const TCHAR *& Str, T & OutNum ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseSignedNumber ( const ANSICHAR *& Str, int32 & OutNum ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseSignedNumber ( const TCHAR *& Str, int32 & OutNum ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseString ( const ANSICHAR *& Str, [FString](API\Runtime\Core\Containers\FString) & OutStr ) }


code: namespace CrossCompiler { bool CrossCompiler::ParseString ( const TCHAR *& Str, [FString](API\Runtime\Core\Containers\FString) & OutStr ) }


className: CullGlobalUniformBuffers

description: Culls global uniform buffer entries from the parameter map.

code: void CullGlobalUniformBuffers ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FUniformBufferEntry](API\Runtime\RenderCore\FUniformBufferEntry) > & UniformBufferMap, [FShaderParameterMap](API\Runtime\RenderCore\FShaderParameterMap) & ParameterMap )


className: DumpDebugBlobDetail

code: static void DumpDebugBlobDetail ( IDxcBlob * Blob, const TCHAR * BlobName )


className: DumpDebugShaderBinary

code: void DumpDebugShaderBinary ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, void * InData, int32 InDataByteSize, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


code: void DumpDebugShaderBinary ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, void * InData, int32 InDataByteSize, const [FString](API\Runtime\Core\Containers\FString) & FileName, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


className: DumpDebugShaderDisassembledDxil

code: void DumpDebugShaderDisassembledDxil ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, void * InData, int32 InDataByteSize, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


className: DumpDebugShaderDisassembledSpirv

code: void DumpDebugShaderDisassembledSpirv ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, void * InData, int32 InDataByteSize, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


className: DumpDebugShaderText

code: void DumpDebugShaderText ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FString](API\Runtime\Core\Containers\FString) & InSource, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


code: void DumpDebugShaderText ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, ANSICHAR * InSource, int32 InSourceLength, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


code: void DumpDebugShaderText ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, ANSICHAR * InSource, int32 InSourceLength, const [FString](API\Runtime\Core\Containers\FString) & FileName, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


className: EShaderConductorTarget

code: enum EShaderConductorTarget { Dxil, Spirv, }


description: Implement to output debug info for a single compile job; only called if SupportsIndependentPreprocessing returns true. This will be called for all jobs (including those found in the job cache) but only if debug info is enabled for the job. Note that any debug info output in CompilePreprocessedShader will only be done for the job that actually executes the compile step, as such any debug outputs that are desirable for all jobs should be written by this function. A BaseShaderFormat implementation is provided in ShaderCompilerCommon which dumps preprocessed and stripped USFs along with the hash of the shader code in an OutputHash.txt file; if no additional custom debug output is required the shader format can inherit fromFBaseShaderFormatinstead ofIShaderFormat.

code: virtual void OutputDebugData ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & PreprocessOutput, const [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output ) const


className: FBaseShaderFormat

code: class FBaseShaderFormat : public [IShaderFormat](API\Developer\TargetPlatform\Interfaces\IShaderFormat)


code: [FString](API\Runtime\Core\Containers\FString) GetDebugShaderPath ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) const


className: FDebugShaderDataOptions

code: struct FDebugShaderDataOptions

type: union UE::Shade...

AdditionalOutputs

type: TArray<FAdditi...

AppendPostSource

type: TFunction<FStr...

FilenamePrefix

type: const TCHAR ...


className: FDiagnosticMessage

code: struct FDiagnosticMessage

File

type: FString


className: FDiagnostics

code: struct FDiagnostics

Errors

type: TArray<FDiagno...


code: FDllHandle ( const TCHAR * InFilename )


code: virtual ~FDllHandle()


className: FDllHandle

code: struct FDllHandle : public [FRefCountedObject](API\Runtime\Core\Templates\FRefCountedObject)


code: uint32 GetModuleVersionHash() const


code: virtual ~FDxcModuleWrapper()


className: FDxcModuleWrapper

code: class FDxcModuleWrapper


className: FAdditionalOutput

code: struct FAdditionalOutput


className: FAccelerationStructure

code: struct FAccelerationStructure


className: FAttribute

code: struct FAttribute


className: FPackedGlobal

code: struct FPackedGlobal

PackedType

type: ANSICHAR


className: FMember

code: struct FMember


className: FInOut

code: struct FInOut


className: FPackedUB

description: Struct FUniform

code: struct FPackedUB

Attribute

type: FAttribute

Members

type: TArray<FMember...


className: FPackedUBCopy

code: struct FPackedUBCopy


className: FUAV

code: struct FUAV


className: FSampler

code: struct FSampler

SamplerStates

type: TArray<FString...


description: After the standard header, different backends can output their own info.

code: virtual bool ParseCustomHeaderEntries ( const ANSICHAR *& ShaderSource )


code: bool Read ( const ANSICHAR *& ShaderSource, int32 SourceLen )


code: static bool ReadCopies ( const ANSICHAR *& ShaderSource, bool bGlobals, [TArray](API\Runtime\Core\Containers\TArray)< [FPackedUBCopy](API\Developer\ShaderCompilerCommon\FHlslccHeader\FPackedUBCopy) > & OutCopies )


code: static bool ReadInOut ( const ANSICHAR *& ShaderSource, [TArray](API\Runtime\Core\Containers\TArray)< [FInOut](API\Developer\ShaderCompilerCommon\FHlslccHeader\FInOut) > & OutAttributes )


code: virtual ~FHlslccHeader()


className: FHlslccHeader

code: struct FHlslccHeader

AccelerationStructures

type: TArray<FAccele...

Inputs

type: TArray<FInOut...

PackedGlobals

type: TArray<FPacked...

description: TArrayUniforms;.

Samplers

type: TArray<FSample...

type: TArray<FAttrib...

UAVs

type: TArray<FUAV>


code: static [EPackedTypeName](API\Runtime\RenderCore\CrossCompiler__EPackedTypeName) EncodePackedGlobalType ( const SpvReflectTypeDescription & TypeDescription, bool bHalfPrecision )


description: Returns the finalized meta data.


code: void WriteAccelerationStructures ( const TCHAR * ResourceName, uint32 BindingIndex )


code: void WriteArgumentBuffers ( uint32 BindingIndex, const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & ResourceIndices )


code: void WriteInputAttribute ( const SpvReflectInterfaceVariable & Attribute )


code: void WriteCompilerInfo ( const TCHAR * CompilerName )


code: void WriteInputAttribute ( const TCHAR * AttributeName, const TCHAR * TypeSpecifier, int32 Location, bool bLocationPrefix, bool bLocationSuffix )


code: void WriteNumThreads ( uint32 NumThreadsX, uint32 NumThreadsY, uint32 NumThreadsZ )


code: void WriteOutputAttribute ( const SpvReflectInterfaceVariable & Attribute )


code: void WriteOutputAttribute ( const TCHAR * AttributeName, const TCHAR * TypeSpecifier, int32 Location, bool bLocationPrefix, bool bLocationSuffix )


code: void WritePackedGlobal ( const SpvReflectBlockVariable & Variable )


code: void WritePackedGlobal ( const TCHAR * ResourceName, [EPackedTypeName](API\Runtime\RenderCore\CrossCompiler__EPackedTypeName) PackedType, uint32 ByteOffset, uint32 ByteSize )


code: void WritePackedUB ( uint32 BindingIndex )


code: void WritePackedUB ( const [FString](API\Runtime\Core\Containers\FString) & UBName, uint32 BindingIndex )


code: void WritePackedUBCopy ( uint32 SourceCB, uint32 SourceOffset, uint32 DestCBIndex, uint32 DestCBPrecision, uint32 DestOffset, uint32 Size, bool bGroupFlattenedUBs )


code: void WritePackedUBField ( const TCHAR * ResourceName, uint32 ByteOffset, uint32 ByteSize )


code: void WritePackedUBField ( const [FString](API\Runtime\Core\Containers\FString) & UBName, const TCHAR * ResourceName, uint32 ByteOffset, uint32 ByteSize )


code: void WritePackedUBGlobalCopy ( uint32 SourceCB, uint32 SourceOffset, uint32 DestCBIndex, uint32 DestCBPrecision, uint32 DestOffset, uint32 Size, bool bGroupFlattenedUBs )


code: void WriteSideTable ( const TCHAR * ResourceName, uint32 SideTableIndex )


code: void WriteSamplerState ( const TCHAR * ResourceName, uint32 BindingIndex )


code: void WriteSourceInfo ( const TCHAR * VirtualSourceFilePath, const TCHAR * EntryPointName )


code: void WriteSRV ( const TCHAR * ResourceName, uint32 BindingIndex, uint32 Count )


code: void WriteSRV ( const TCHAR * ResourceName, uint32 BindingIndex, uint32 Count, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AssociatedResourceNames )


code: void WriteUAV ( const TCHAR * ResourceName, uint32 BindingIndex, uint32 Count )


code: void WriteUniformBlock ( const TCHAR * ResourceName, uint32 BindingIndex )


className: FHlslccHeaderWriter

code: class FHlslccHeaderWriter


code: bool operator== ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


code: bool operator>= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


code: bool operator> ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


code: bool operator< ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


code: bool operator<= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


code: bool operator!= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const


className: FindOffsetToSpirvEntryPoint

description: Returns word offset to the entry point (OpEntryPoint) and name of the entry point (OpName). If the respective entry has not been found, the output offset is 0.

code: void FindOffsetToSpirvEntryPoint ( const [FSpirv](API\Developer\ShaderCompilerCommon\FSpirv) & Spirv, const ANSICHAR * EntryPointName, uint32 & OutWordOffsetToEntryPoint, uint32 & OutWordOffsetToMainName )


className: FHlslShaderModel

description: Shader model version for HLSL input language.

code: struct FHlslShaderModel

Major

description: Major shader model version (e.g. 6 in SM6.2).

Minor

description: Minor shader model version (e.g. 2 in SM6.2).


code: bool Success() const


className: FMinifiedShader

code: struct FMinifiedShader

Diagnostics

type: FDiagnostics


description: Compiles the specified HLSL shader source code to SPIR-V.

code: bool CompileHlslToSpirv ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & OutSpirv )


description: Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as null terminated ANSI string.

code: bool CompileSpirvToSourceAnsi ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, [TArray](API\Runtime\Core\Containers\TArray)< ANSICHAR > & OutSource )


description: Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as byte buffer (without null terminator as it comes from ShaderConductor).

code: bool CompileSpirvToSourceBuffer ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const void *Data, uint32 Size)> & OutputCallback )


description: Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL).

code: bool CompileSpirvToSource ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, [FString](API\Runtime\Core\Containers\FString) & OutSource )


description: Convert array of error string lines into array of.

code: static void ConvertCompileErrors ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && ErrorStringLines, [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors )


description: Disassembles the specified SPIR-V module and returns its assembly as text representation.

code: static bool Disassemble ( [EShaderConductorIR](API\Developer\ShaderCompilerCommon\CrossCompiler__EShaderConductorI-) Language, const void * Binary, uint32 BinaryByteSize, [TArray](API\Runtime\Core\Containers\TArray)< ANSICHAR > & OutAssemblyText )


description: Returns the list of current compile errors.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & GetErrors() const


description: Flushes the list of current compile errors and moves the ownership to the caller.

code: void FlushErrors ( [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors )


description: Returns the table of special identifiers generated by ShaderConductor.

code: static const [FShaderConductorIdentifierTable](API\Developer\ShaderCompilerCommon\FShaderConductorIdentifierTable) & GetIdentifierTable()


description: Returns a filename extension for the specified shading language and shader stage, e.g. "frag" for a GLSL pixel shader.

code: static const TCHAR * GetShaderFileExt ( [EShaderConductorLanguage](API\Developer\ShaderCompilerCommon\CrossCompiler__EShaderConductorL-) Language, EShaderFrequency ShaderStage )


description: Returns a length of the internal loaded sources (excluding the null terminator). This is automatically updated whenRewriteHlsl()is called.

code: int32 GetSourceLength() const


description: Returns a pointer to a null terminated ANSI string of the internal loaded sources, or null if no source has been loaded yet. This is automatically updated whenRewriteHlsl()is called.

code: const ANSICHAR * GetSourceString() const


description: Returns whether the specified variable name denotes an intermediate output variable. This is only true for a special identifiers generated by DXC to communicate patch constant data in the Hull Shader.

code: static bool IsIntermediateSpirvOutputVariable ( const ANSICHAR * SpirvVariableName )


description: Loads the shader source and converts the input descriptor to a format suitable for ShaderConductor. If 'Definitions' is null, the previously loaded definitions are not modified.

code: bool LoadSource ( const [FString](API\Runtime\Core\Containers\FString) & ShaderSource, const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FString](API\Runtime\Core\Containers\FString) & EntryPoint, EShaderFrequency ShaderStage, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) * Definitions, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * ExtraDxcArgs )


code: bool LoadSource ( const ANSICHAR * ShaderSource, const ANSICHAR * Filename, const ANSICHAR * EntryPoint, EShaderFrequency ShaderStage, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) * Definitions, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * ExtraDxcArgs )


description: Performs the specified optimization passes (e.g. "-O" or "--strip-reflect") on the SPIR-V module.

code: bool OptimizeSpirv ( [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & Spirv, const ANSICHAR *const * OptConfigs, int32 OptConfigCount )


code: [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & operator= ( const [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & )


description: Move operator to take ownership of internal buffers from 'Rhs'.

code: [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & operator= ( [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) && Rhs )


description: Rewrites the specified HLSL shader source code. This allows to reduce the HLSL code by removing unused global resources for instance. This will update the internally loaded source (see 'LoadSource'), so the output parameter 'OutSource' is optional.

code: bool RewriteHlsl ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, [FString](API\Runtime\Core\Containers\FString) * OutSource )


description: Explicitly shut down ShaderConductor and DXC shared libraries. Only used for Linux to prevent dangling mutex on exit.

code: static void Shutdown()


description: Initializes the context with internal buffers used for the conversion of input and option descriptors between UE and ShaderConductor.

code: FShaderConductorContext()


description: Move constructor to take ownership of internal buffers from 'Rhs'.

code: FShaderConductorContext ( [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) && Rhs )


code: FShaderConductorContext ( const [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & )


description: Release the internal buffers.

code: ~FShaderConductorContext()


className: FShaderConductorContext

description: Wrapper class to handle interface between UE and ShaderConductor. Use to compile HLSL shaders to SPIR-V or high-level languages such as Metal.

code: class FShaderConductorContext


className: FShaderConductorIdentifierTable

description: Container for all special case SPIR-V identifiers generated by ShaderConductor.

code: struct FShaderConductorIdentifierTable

DummySampler

type: const ANSICHAR ...

description: Identifier for dummy samplers used for platforms where samplers are required

GlobalsUniformBuffer

description: Identifier for globals uniform buffers: "$Globals".

InputAttribute

description: Identifier for vertex input attributes: "in.var.ATTRIBUTE".

IntermediateTessControlOutput

description: Identifier for the intermediate output variable in a tessellation-control shader.


code: uint32 GetModuleVersionHash() const


code: FShaderConductorModuleWrapper()


className: FShaderConductorModuleWrapper

code: class FShaderConductorModuleWrapper : private [FDxcModuleWrapper](API\Developer\ShaderCompilerCommon\FDxcModuleWrapper)


className: ETargetEnvironment

code: enum ETargetEnvironment { Vulkan_1_0, Vulkan_1_1, Vulkan_1_2, Vulkan_1_3, }


className: FShaderConductorOptions

description: Wrapper structure to pass options descriptor to ShaderConductor. This is mapped to.

code: struct FShaderConductorOptions

bDisableOptimizations

type: bool

description: Force to turn off optimizations. Ignore optimizationLevel below.

bDisableScalarBlockLayout

description: Disables scalar block layout for structured buffers.

description: Enable 16-bit types, such as half, uint16_t. Requires shader model 6.2+.

bEnableDebugInfo

description: Embed debug info into the binary.

bEnableFMAPass

description: Enable a pass that converts floating point MUL+ADD pairs into FMAs to avoid re-association.

bEnableSeparateSamplersInGlsl

description: Enables separate samplers in GLSL via extensions.

bPackMatricesInRowMajor

description: Experimental: Decide how a matrix get packed.

bPreserveStorageInput

description: Preserve storage inputs used for OpenGL

bRemapAttributeLocations

description: Enables re-mapping of input/output attribute locations to include padding for arrays.

bRemoveUnusedGlobals

description: Removes unused global variables and resources.

bSvPositionImplicitInvariant

description: Decorate SV_Position implicitly as invariant.

HlslVersion

description: HLSL language input version: 2015, 2016, 2017, 2018 (Default), 2021 (Breaking changes in short-circuiting evaluation).

ShaderModel

type: FHlslShaderMode...

description: Shader model version of the input language.Bydefault SM6.2.

TargetEnvironment

type: ETargetEnvironm...


className: FShaderConductorTarget

description: Shader conductor output target descriptor.

code: struct FShaderConductorTarget

CompileFlags

type: FShaderCompiler...

description: Cross compilation flags.

Language

type: EShaderConducto...

description: Target shader semantics, e.g. "macOS" or "iOS" for Metal GPU semantics.

VariableTypeRenameCallback

type: TFunction< bool...

description: Optional callback to rename certain variable types.

Version

description: Target shader version.


description: Returns a constant iterator to the first instruction in this SPIR-V module.


description: Returns an iterator to the first instruction in this SPIR-V module.


description: Returns a constant iterator to the end of this SPIR-V module.


description: Returns an iterator to the end of this SPIR-V module.


description: Returns a byte pointer to the SPIR-V data.

code: int8 * GetByteData()


code: const int8 * GetByteData() const


description: Returns the size of this SPIR-V module in bytes.

code: int32 GetByteSize() const


description: Returns the word offset to the instruction the specified iterator points to plus additional operand word offset.

code: uint32 GetWordOffset ( const [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) & Iter, uint32 OperandWordOffset ) const


className: FSpirv

description: Base structure for SPIR-V modules in the shader backends.

code: struct FSpirv

Data

type: TArray< uint32 ...


className: FSpirvConstIterator

code: typedef [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator)< const uint32 > FSpirvConstIterator


className: FSpirvIterator

code: typedef [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator)< uint32 > FSpirvIterator


description: Adds the specified descriptor binding to the corresponding container iff the descriptor is marked as being accessed.

code: void AddDescriptorBinding ( SpvReflectDescriptorBinding * InBinding )


description: Assigns the binding location for all input attributes by its semantic index if their name is equal to 'SemanticName'. Used for vertex shaders where all input attributes have the "ATTRIBUTE" semantic.

code: void AssignInputAttributeLocationsBySemanticIndex ( spv_reflect::ShaderModule & SpirvReflection, const ANSICHAR * SemanticName )


description: Gathers all descriptor bindings from the specified SPIRV-Reflect module.

code: void GatherDescriptorBindings ( const spv_reflect::ShaderModule & SpirvReflection )


description: Gathers all input interface variables from the specified SPIRV-Reflect module.

code: void GatherInputAttributes ( const spv_reflect::ShaderModule & SpirvReflection )


description: Gathers all output interface variables from the specified SPIRV-Reflect module.

code: void GatherOutputAttributes ( const spv_reflect::ShaderModule & SpirvReflection )


className: GetNumUniformBuffersUsed

description: Finds the number of used uniform buffers in a resource map.

code: int16 GetNumUniformBuffersUsed ( const [FShaderCompilerResourceTable](API\Runtime\RenderCore\FShaderCompilerResourceTable) & InSRT )


className: FSpirvReflectBindings

description: Container structure for all SPIR-V reflection resources and in/out attributes.

code: struct FSpirvReflectBindings

AccelerationStructures

type: TArray< SpvRefl...

AtomicCounters

type: TSet< SpvReflec...


code: void HandleReflectedGlobalConstantBufferMember ( const [FString](API\Runtime\Core\Containers\FString) & MemberName, uint32 ConstantBufferIndex, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedRootConstantBufferMember

code: void HandleReflectedRootConstantBufferMember ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderParameterParser](API\Runtime\RenderCore\FShaderParameterParser) & ShaderParameterParser, const [FString](API\Runtime\Core\Containers\FString) & MemberName, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedRootConstantBuffer

code: void HandleReflectedRootConstantBuffer ( int32 ConstantBufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedShaderResource

code: void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedShaderSampler

code: void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedShaderUAV

code: void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedUniformBufferConstantBufferMember ( int32 UniformBufferSlot, const [FString](API\Runtime\Core\Containers\FString) & MemberName, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: HandleReflectedUniformBuffer

code: void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, int32 BufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


code: void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, int32 BaseIndex, int32 BufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: PatchSpirvEntryPointWithCRC

description: Renames the fixed-size entry point name (which must be "main_00000000_00000000") to the formatted name including a CRC over the module. Returns the new entry point name.

code: const ANSICHAR * PatchSpirvEntryPointWithCRC ( [FSpirv](API\Developer\ShaderCompilerCommon\FSpirv) & Spirv, uint32 & OutCRC )


className: RemoveUnusedInputs

code: bool RemoveUnusedInputs ( [FString](API\Runtime\Core\Containers\FString) & InOutSourceCode, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InUsedInputs, [FString](API\Runtime\Core\Containers\FString) & InOutEntryPoint, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutErrors )


className: RemoveUniformBuffersFromSource

description: The cross compiler doesn't yet support struct initializers needed to construct static structs for uniform buffers Replace all uniform buffer struct member references (View.WorldToClip) with a flattened name that removes the struct dependency (View_WorldToClip)

code: void RemoveUniformBuffersFromSource ( const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & Environment, [FString](API\Runtime\Core\Containers\FString) & PreprocessedShaderSource )


className: RemoveUnusedOutputs

code: bool RemoveUnusedOutputs ( [FString](API\Runtime\Core\Containers\FString) & InOutSourceCode, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InUsedOutputs, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InExceptions, [FString](API\Runtime\Core\Containers\FString) & InOutEntryPoint, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutErrors )


className: TransformStringIntoCharacterArray

description: Processes TEXT macros.

code: void TransformStringIntoCharacterArray ( [FString](API\Runtime\Core\Containers\FString) & PreprocessedShaderSource )


description: Returns the opcode of the current instruction.

code: SpvOp Opcode() const


description: Dereferences the value the current operand points to.

code: uint32 Operand ( int32 WordOffset ) const


description: Returns the operand as the specified reinterpreted type.

code: template<typename TDst> TDst OperandAs ( int32 WordOffset ) const


description: Returns the operand pointer as ANSI C string.

code: const ANSICHAR * OperandAsString ( int32 WordOffset ) const


code: [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & operator= ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other )


description: Returns whether this iterator points to the same address as the other iterator.

code: bool operator== ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other ) const


description: Returns whether this iterator does not point to the same address as the other iterator.

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


description: Increments the iterator to point to the next SPIR-V instruction and returns the previous iterator state.

code: [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) operator++ ( int )


description: Returns a pointer to the beginning of the SPIR-V instruction this iterator currently points to.

code: T * operator*() const


description: Increments the iterator to point to the next SPIR-V instruction.


description: Returns the word count of the current instruction. A valid SPIR-V instruction must have a word count greater zero.

code: uint32 WordCount() const


description: Initializes the iterator with a null pointer.

code: TSpirvForwardIterator()


code: TSpirvForwardIterator ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other )


description: Initializes the iterator with the specified pointer.

code: TSpirvForwardIterator ( T * InPtr, bool bPointsAtHeader )


className: TSpirvForwardIterator

description: Template forward iterator for SPIR-V instructions.

code: template<typename T> class TSpirvForwardIterator


code: namespace UE { namespace ShaderCompilerCommon { static constexpr const TCHAR * UE::ShaderCompilerCommon::kUniformBufferConstantBufferPrefix = TEXT("UniformBufferConstants_"); } }


code: namespace UE { namespace ShaderCompilerCommon { static constexpr const TCHAR * UE::ShaderCompilerCommon::kBindlessResourcePrefix = TEXT("BindlessResource_"); } }


code: namespace UE { namespace ShaderCompilerCommon { static constexpr const TCHAR * UE::ShaderCompilerCommon::kBindlessSamplerPrefix = TEXT("BindlessSampler_"); } }


description: Deprecated* Deprecated; use FShaderCompilerInput::ShouldUseStableContantBuffer directly

code: namespace UE { namespace ShaderCompilerCommon { bool UE::ShaderCompilerCommon::ShouldUseStableConstantBuffer ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input ) } }


code: namespace UE { namespace ShaderCompilerCommon { FStringView UE::ShaderCompilerCommon::RemoveConstantBufferPrefix ( FStringView InName ) } }


code: namespace UE { namespace ShaderCompilerCommon { [FString](API\Runtime\Core\Containers\FString) UE::ShaderCompilerCommon::RemoveConstantBufferPrefix ( const [FString](API\Runtime\Core\Containers\FString) & InName ) } }


description: Deprecated* Deprecated; useFShaderParameterParser::ParseAndRemoveBindlessParameterPrefixinstead

code: namespace UE { namespace ShaderCompilerCommon { EShaderParameterType UE::ShaderCompilerCommon::ParseAndRemoveBindlessParameterPrefix ( FStringView & InName ) } }


description: Deprecated* Deprecated; use FShaderParameterParser::ParseAndRemoveBindlessParameterPrexix instead

code: namespace UE { namespace ShaderCompilerCommon { EShaderParameterType UE::ShaderCompilerCommon::ParseAndRemoveBindlessParameterPrefix ( [FString](API\Runtime\Core\Containers\FString) & InName ) } }


description: Deprecated* Deprecated; useFShaderParameterParser::RemoveBindlessParameterPrefixinstead

code: namespace UE { namespace ShaderCompilerCommon { bool UE::ShaderCompilerCommon::RemoveBindlessParameterPrefix ( [FString](API\Runtime\Core\Containers\FString) & InName ) } }


code: namespace UE { namespace ShaderCompilerCommon { bool UE::ShaderCompilerCommon::ValidatePackedResourceCounts ( [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const [FShaderCodePackedResourceCounts](API\Runtime\RenderCore\FShaderCodePackedResourceCounts) & PackedResourceCounts ) } }


description: Parses ray tracing shader entry point specification string in one of the following formats: 1) Verbatim single entry point name, e.g. "MainRGS" 2) Complex entry point for ray tracing hit group shaders: a) "closesthit=MainCHS" b) "closesthit=MainCHS anyhit=MainAHS" c) "closesthit=MainCHS anyhit=MainAHS intersection=MainIS" d) "closesthit=MainCHS intersection=MainIS" NOTE: closesthit attribute must always be provided for complex hit group entry points

code: namespace UE { namespace ShaderCompilerCommon { void UE::ShaderCompilerCommon::ParseRayTracingEntryPoint ( const [FString](API\Runtime\Core\Containers\FString) & Input, [FString](API\Runtime\Core\Containers\FString) & OutMain, [FString](API\Runtime\Core\Containers\FString) & OutAnyHit, [FString](API\Runtime\Core\Containers\FString) & OutIntersection ) } }


description: Deprecated* Deprecated; useFShaderParameterParser::ParseParameterTypeinstead

code: namespace UE { namespace ShaderCompilerCommon { EShaderParameterType UE::ShaderCompilerCommon::ParseParameterType ( FStringView InType, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const TCHAR *const > InExtraSRVTypes, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const TCHAR *const > InExtraUAVTypes ) } }


description: Rewrites a fully preprocessed shader source code, removing any functions or structs that are not reachable from a given entry point or list of symbols. This is a high-level wrapper for UE::ShaderMinifier that should be used in all shader compiler back-ends for consistency. Any errors encountered during parsing or minification are added to OutErrors. InOutPreprocessedShaderSource is replaced with the rewritten code on success and is kept intact on failure.

code: namespace UE { namespace ShaderCompilerCommon { bool UE::ShaderCompilerCommon::RemoveDeadCode ( [FString](API\Runtime\Core\Containers\FString) & InOutPreprocessedShaderSource, const [FString](API\Runtime\Core\Containers\FString) & EntryPoint, [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors ) } }


code: namespace UE { namespace ShaderCompilerCommon { bool UE::ShaderCompilerCommon::RemoveDeadCode ( [FString](API\Runtime\Core\Containers\FString) & InOutPreprocessedShaderSource, TConstArrayView< FStringView > RequiredSymbols, [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors ) } }


code: namespace UE { namespace ShaderMinifier { enum EMinifyShaderFlags { None = 0, OutputReasons = 1 << 1, OutputStats = 1 << 2, OutputLines = 1 << 3, OutputCommentLines = 1 << 4, } } }


code: namespace UE { namespace ShaderMinifier { [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & UE::ShaderMinifier::operator|= ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & UE::ShaderMinifier::operator&= ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & UE::ShaderMinifier::operator^= ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) & Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { constexpr [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) UE::ShaderMinifier::operator| ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { constexpr [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) UE::ShaderMinifier::operator& ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { constexpr [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) UE::ShaderMinifier::operator^ ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Lhs, [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) Rhs ) } }


code: namespace UE { namespace ShaderMinifier { constexpr bool UE::ShaderMinifier::operator! ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) E ) } }


code: namespace UE { namespace ShaderMinifier { constexpr [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) UE::ShaderMinifier::operator~ ( [EMinifyShaderFlags](API\Developer\ShaderCompilerCommon\UE__ShaderMinifier__EMinifyShade-) E ) } }


className: UpdateStructuredBufferStride

code: void UpdateStructuredBufferStride ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FString](API\Runtime\Core\Containers\FString) & ResourceName, uint16 BindPoint, uint16 Stride, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput )


className: WriteShaderConductorCommandLine

code: void WriteShaderConductorCommandLine ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FString](API\Runtime\Core\Containers\FString) & SourceFilename, [EShaderConductorTarget](API\Developer\ShaderCompilerCommon\EShaderConductorTarget) Target )


module: ShaderFormatOpenGL

code: virtual bool AllowsESLanguage()


description: Subclass functionality

code: virtual bool AllowsGlobalUniforms()


description: Return false if there were restrictions that made compilation fail.

code: virtual bool ApplyAndVerifyPlatformRestrictions ( exec_list * Instructions, _mesa_glsl_parse_state * ParseState, EHlslShaderFrequency Frequency )


code: ir_function_signature * FindPatchConstantFunction ( exec_list * Instructions, _mesa_glsl_parse_state * ParseState )


code: virtual char * GenerateCode ( struct exec_list * ir, struct _mesa_glsl_parse_state * ParseState, EHlslShaderFrequency Frequency )


description: Generate a GLSL main() function that calls the entry point and handles reading and writing all input and output semantics.

code: virtual bool GenerateMain ( EHlslShaderFrequency Frequency, const char * EntryPoint, exec_list * Instructions, _mesa_glsl_parse_state * ParseState )


code: FGlslCodeBackend ( unsigned int InHlslCompileFlags, EHlslCompileTarget InTarget )


code: virtual bool WantsPrecisionModifiers()


className: FGlslCodeBackend

description: Generates GLSL compliant code from IR tokens.

code: struct FGlslCodeBackend : public FCodeBackend


code: virtual bool AllowsImageLoadsForNonScalar() const


code: virtual bool AllowsSharingSamplers() const


code: virtual bool EmulateStructuredWithTypedBuffers() const


code: virtual void SetupLanguageIntrinsics ( _mesa_glsl_parse_state * State, exec_list * ir )


code: virtual bool SupportsDeterminantIntrinsic() const


code: virtual bool SupportsIntegerModulo() const


code: virtual bool SupportsMatrixConversions() const


code: virtual bool SupportsTransposeIntrinsic() const


code: FGlslLanguageSpec ( bool bInDefaultPrecisionIsHalf )


description: Construct the final microcode from the compiled and verified shader source.

code: void BuildShaderOutput ( [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & ShaderOutput, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & ShaderInput, const ANSICHAR * InShaderSource, int32 SourceLen, [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version )


className: FGlslLanguageSpec

code: class FGlslLanguageSpec : public ILanguageSpec


code: virtual uint32 CalculateCrossCompilerFlags ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, const bool bFullPrecisionInPS, const [FShaderCompilerFlags](API\Runtime\RenderCore\FShaderCompilerFlags) & CompilerFlags )


code: void CompileOffline ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & ShaderInput, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) ShaderVersion, const ANSICHAR * InShaderSource )


description: Compile a shader for OpenGL on Windows.

code: void CompileShader ( const struct [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, struct [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const class [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory, [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version )


code: virtual void ConvertOpenGLVersionFromGLSLVersion ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) InVersion, int & OutMajorVersion, int & OutMinorVersion )


description: Create the compiling backend

code: virtual [FGlslCodeBackend](API\Developer\ShaderFormatOpenGL\FGlslCodeBackend) * CreateBackend ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, uint32 CCFlags, EHlslCompileTarget HlslCompilerTarget )


description: Create the language spec

code: virtual [FGlslLanguageSpec](API\Developer\ShaderFormatOpenGL\FGlslLanguageSpec) * CreateLanguageSpec ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, bool bDefaultPrecisionIsHalf )


description: Fills device capabilities in 'offline', mostly hardcoded values

code: void FillDeviceCapsOfflineCompilation ( struct FDeviceCapabilities & Caps, const [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) ShaderVersion ) const


description: What is the max number of samplers the shader platform can use?

code: virtual uint32 GetMaxSamplers ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version )


code: virtual bool IsSM5 ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version )


description: Allow subclass to write out different output, returning true if it did write everything it needed

code: virtual bool OptionalSerializeOutputAndReturnIfSerialized ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: If true, the shader output map will contain true names (i.e. ColorModifier) instead of helper names for runtime binding (i.e. pb_5)

code: virtual bool OutputTrueParameterNames()


description: Based on ShaderVersion decides what platform specific compiler to use

code: void PlatformCompileOffline ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & ShaderOutput, const ANSICHAR * ShaderSource, const [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) ShaderVersion )


code: bool PlatformSupportsOfflineCompilation ( const [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) ShaderVersion ) const


description: Precompile a GLSL shader.

code: void PrecompileShader ( [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & ShaderOutput, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & ShaderInput, const ANSICHAR * ShaderSource, [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, EHlslShaderFrequency Frequency )


description: Allow a subclass to perform additional work on the cross compiled source code.

code: virtual bool PostProcessShaderSource ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, EShaderFrequency Frequency, const ANSICHAR * ShaderSource, uint32 SourceLen, class [FShaderParameterMap](API\Runtime\RenderCore\FShaderParameterMap) & ParameterMap, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & BindingNameMap, [TArray](API\Runtime\Core\Containers\TArray)< struct [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & Errors, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & ShaderInput )


description: Final source code processing, based on device capabilities, before actual (offline) compilation; it mostly mirrors the behaviour of OpenGLShaders.cpp/GLSLToDeviceCompatibleGLSL()

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ANSICHAR > PrepareCodeForOfflineCompilation ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) ShaderVersion, EShaderFrequency Frequency, const ANSICHAR * InShaderSource ) const


description: Set up compilation information like defines and HlslCompileTarget

code: virtual void SetupPerVersionCompilationEnvironment ( [GLSLVersion](API\Developer\ShaderFormatOpenGL\GLSLVersion) Version, class [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) & AdditionalDefines, EHlslCompileTarget & HlslCompilerTarget )


code: virtual ~FOpenGLFrontend()


className: FOpenGLFrontend

code: class FOpenGLFrontend


className: GLSLVersion

code: enum GLSLVersion { GLSL_150_REMOVED, GLSL_430_REMOVED, GLSL_ES2_REMOVED, GLSL_ES2_WEBGL_REMOVED, GLSL_150_ES2_DEPRECATED, GLSL_150_ES2_NOUB_DEPRECATED, GLSL_150_ES3_1, GLSL_ES2_IOS_REMOVED, GLSL_310_ES_EXT_REMOVED, GLSL_ES3_1_ANDROID, GLSL_SWITCH, GLSL_SWITCH_FORWARD, GLSL_MAX, }


module: ShaderFormatVectorVM

code: bool CompileShader_VectorVM ( const struct [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, struct [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const class [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory, uint8 Version )


description: Cheating hack version. To be removed when we add all the plumbing for VVM scripts to be treat like real shaders.

code: bool CompileShader_VectorVM ( const struct [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, struct [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & Output, const class [FString](API\Runtime\Core\Containers\FString) & WorkingDirectory, uint8 Version, struct [FVectorVMCompilationOutput](API\Developer\ShaderFormatVectorVM\FVectorVMCompilationOutput) & VMCompilationOutput, bool bSkipBackendOptimizations )


className: FCalledVMFunction

description: Ordered table of functions actually called by the VM script.

code: struct FCalledVMFunction

InputParamLocations

type: TArray< bool >

Name

type: FString


code: FVectorVMCompilationOutput()


className: FVectorVMCompilationOutput

description: Data which is generated from the hlsl by the VectorVMBackend and fed back into the

code: struct FVectorVMCompilationOutput

ByteCode

type: TArray< uint8 >

CalledVMFunctionTable

type: TArray<FCalled...

InternalConstantOffsets

type: TArray< int32 >

InternalConstantTypes

type: TArray< EVector...


className: operator<<

code: [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FCalledVMFunction](API\Developer\ShaderFormatVectorVM\FCalledVMFunction) & Function )


code: [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FVectorVMCompilationOutput](API\Developer\ShaderFormatVectorVM\FVectorVMCompilationOutput) & Output )


className: EDumpShaderDefines

description: Governs the behavior for adding shader defines to the preprocessed source. Can be helpful for the debugging, but makes the source unique which can prevent efficient caching.

module: ShaderPreprocessor

code: enum EDumpShaderDefines { DontCare, DontIncludeDefines, AlwaysIncludeDefines, }


className: PreprocessShader

description:
Preprocess a shader.
true if the shader is preprocessed without error.

code: bool PreprocessShader ( [FString](API\Runtime\Core\Containers\FString) & OutPreprocessedShader, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & ShaderOutput, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & ShaderInput, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) & AdditionalDefines, [EDumpShaderDefines](API\Developer\ShaderPreprocessor\EDumpShaderDefines) DefinesPolicy )


description:
Preprocess a shader.
Preprocess a shader.
true if the shader is preprocessed without error.

code: bool PreprocessShader ( [FShaderPreprocessOutput](API\Runtime\RenderCore\FShaderPreprocessOutput) & Output, const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & MergedEnvironment, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) & AdditionalDefines, [EDumpShaderDefines](API\Developer\ShaderPreprocessor\EDumpShaderDefines) DefinesPolicy )


description: Finalizes the updater, and writes it back to the file, returning true if successful, and false if there were any errors.

module: SharedSettingsWidgets

code: bool Finalize ( const [FString](API\Runtime\Core\Containers\FString) & TargetFilename, bool bShowNotifyOnFailure, [FFileHelper::EEncodingOptions](API\Runtime\Core\Misc\FFileHelper\EEncodingOptions) EncodingOption )


description: Returns the first error message.


description: Checks if a key exists matching MatchPrefix.

code: bool HasKey ( const [FString](API\Runtime\Core\Containers\FString) & MatchPrefix )


description: Replace a key in the manifest (between MatchPrefix and MatchSuffix) with NewInfix.

code: void ReplaceKey ( const [FString](API\Runtime\Core\Containers\FString) & MatchPrefix, const [FString](API\Runtime\Core\Containers\FString) & MatchSuffix, const [FString](API\Runtime\Core\Containers\FString) & NewInfix )


description: Replaces the text in InOutString between MatchPrefix and MatchSuffix with NewInfix, returning true if it was found.

code: static bool ReplaceStringPortion ( [FString](API\Runtime\Core\Containers\FString) & InOutString, const [FString](API\Runtime\Core\Containers\FString) & MatchPrefix, const [FString](API\Runtime\Core\Containers\FString) & MatchSuffix, const [FString](API\Runtime\Core\Containers\FString) & NewInfix )


code: FManifestUpdateHelper ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


className: FManifestUpdateHelper

description: This is a utility class used to update individual sections of an XML manifest or .plist in raw string form. It is formatting sensitive and will fail if things are formatted in an unexpected manner. This is a stopgap measure, and will be replaced using a proper XML parser when it is ready for use.

code: class FManifestUpdateHelper


className: FOnPostExternalImageCopy

description: Delegate fired after an image has been copied

code: typedef TBaseDelegate_OneParam< bool, const [FString](API\Runtime\Core\Containers\FString) & > FOnPostExternalImageCopy


className: FOnPreExternalImageCopy

description: Delegate fired before an image has been copied

code: typedef TBaseDelegate_OneParam< bool, const [FString](API\Runtime\Core\Containers\FString) & > FOnPreExternalImageCopy


className: ERequiredState

code: enum ERequiredState { Required, Optional, }


code: FPlatformIconInfo ( const [FString](API\Runtime\Core\Containers\FString) & InIconPath, [FText](API\Runtime\Core\Internationalization\FText) InIconName, [FText](API\Runtime\Core\Internationalization\FText) InIconDescription, int32 RequiredWidth, int32 RequiredHeight, [ERequiredState](API\Developer\SharedSettingsWidgets\FPlatformIconInfo\ERequiredState) IsRequired )


className: FPlatformIconInfo

code: struct FPlatformIconInfo

IconDescription

type: FText

IconRequiredSize

type: FIntPoint

RequiredState

type: ERequiredState


description: Deprecated* CreateTargetShaderFormatsPropertyView now gets RHI names viaFNameinstead ofFString. Please change your callback function as this is a breaking change.

code: void CreateTargetShaderFormatsPropertyView ( [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, [Deprecated_GetFriendlyNameFromRHINameFnc](API\Developer\SharedSettingsWidgets\FShaderFormatsPropertyDetails\Deprecated_GetFr-) * FriendlyNameFnc )


description: Create the UI to select which windows shader formats we are targeting

code: void CreateTargetShaderFormatsPropertyView ( [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, [GetFriendlyNameFromRHINameFnc](API\Developer\SharedSettingsWidgets\FShaderFormatsPropertyDetails\GetFriendlyNameF-) * FriendlyNameFnc, [FilterShaderPlatformFnc](API\Developer\SharedSettingsWidgets\FShaderFormatsPropertyDetails\FilterShaderPlat-) * FilterShaderPlatformFunc, [ECategoryPriority::Type](API\Editor\PropertyEditor\ECategoryPriority__Type) InPriority )


className: FilterShaderPlatformFnc

code: typedef bool( FilterShaderPlatformFnc


className: GetFriendlyNameFromRHINameFnc


description: Whether this RHI is currently enabled

code: ECheckBoxState IsTargetedRHIChecked ( [FName](API\Runtime\Core\UObject\FName) InRHIName ) const


description: Simple delegate for updating shader version warning

code: void SetOnUpdateShaderWarning ( const FSimpleDelegate & Delegate )


description: Constructor for the parent property details view

code: FShaderFormatsPropertyDetails ( [IDetailLayoutBuilder](API\Editor\PropertyEditor\IDetailLayoutBuilder) * InDetailBuilder, const TCHAR * InProperty, const TCHAR * InTitle )


className: FShaderFormatsPropertyDetails

description: Helper which implements details panel customizations for a device profiles parent property

code: class FShaderFormatsPropertyDetails : public [TSharedFromThis< FShaderFormatsPropertyDetails >](API\Runtime\Core\Templates\TSharedFromThis)


code: void Construct ( const [FArguments](API\Developer\SharedSettingsWidgets\SExternalImageReference\FArguments) & InArgs, const [FString](API\Runtime\Core\Containers\FString) & InBaseFilename, const [FString](API\Runtime\Core\Containers\FString) & InOverrideFilename )


description: If true, deletes the previous reference if the file extension changes

code: WidgetArgsType & DeletePreviousTargetWhenExtensionChanges &40; bool InArg &41;


description: If true, the target image will be deleted if the default is chosen

code: WidgetArgsType & DeleteTargetWhenDefaultChosen &40; bool InArg &41;


description: The description of the file, used in error messages/notifications

code: WidgetArgsType & FileDescription &40; FText InArg &41;


description: File extensions allowed for the external image reference

code: WidgetArgsType & FileExtensions &40; TArray< FString > InArg &41;


description: Tooltip for Generate Image button

code: WidgetArgsType & GenerateImageToolTipText &40; FText InArg &41;


description: Whether to show the generate image button

code: WidgetArgsType & GenerateImageVisibility &40; const TAttribute< EVisibility > & InAttribute &41;


description: How big should we display the image?

code: WidgetArgsType & MaxDisplaySize &40; FVector2D InArg &41;


description: Delegate fired when an Generate Image button is pressed

code: WidgetArgsType & OnGenerateImageClicked &40; const FOnClicked & InDelegate &41;


description: Delegate fired to get the path to start picking from.

code: WidgetArgsType & OnGetPickerPath &40; FOnGetPickerPath InArg &41;


code: WidgetArgsType & OnPostExternalImageCopy &40; FOnPostExternalImageCopy InArg &41;


code: WidgetArgsType & OnPreExternalImageCopy &40; FOnPreExternalImageCopy InArg &41;


description: A property handle to use if required

code: WidgetArgsType & PropertyHandle &40; TSharedPtr< class IPropertyHandle > InArg &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description: How big does the image need to be (any size is allowed if this is omitted)

code: WidgetArgsType & RequiredSize &40; FIntPoint InArg &41;


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SExternalImageReference >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Delegate handler for when an image is picked

code: bool HandleExternalImagePicked ( const [FString](API\Runtime\Core\Containers\FString) & InChosenImage, const [FString](API\Runtime\Core\Containers\FString) & InTargetImage )


code: void Construct ( const [FArguments](API\Developer\SharedSettingsWidgets\SHyperlinkLaunchURL\FArguments) & InArgs, const [FString](API\Runtime\Core\Containers\FString) & InDestinationURL )


className: SExternalImageReference

description: This widget shows an external image preview of a per-project configurable image (one where the engine provides a default, but each project may have its own override)

code: class SExternalImageReference : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

BaseFilename

description: The image on disk that we will use if the override does not exist.

type: bool

description: If true, the previous target image will be deleted if the file extension changes

Extensions

type: TArray<FString...

description: The extensions supported by this external reference

FileDescription

description: The description of the file in question, e.g. 'image' or 'icon', used for error reporting

OnPostExternalImageCopy

type: FOnPostExternal...

OnPreExternalImageCopy

type: FOnPreExternalI...

OverrideFilename

description: The image on disk that the override image is stored as.

PropertyHandle

type: TSharedPtr< cla...

description: A property handle to use if required


description: If set, this text will be used for the display string of the hyperlink

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SHyperlinkLaunchURL >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: SHyperlinkLaunchURL

code: class SHyperlinkLaunchURL : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void Construct ( const [FArguments](API\Developer\SharedSettingsWidgets\SPlatformSetupMessage\FArguments) & InArgs, const [FString](API\Runtime\Core\Containers\FString) & InTargetFilename )


className: ESetupState

code: enum ESetupState { MissingFiles, NeedsCheckout, ReadOnlyFiles, ReadyToModify, GettingStatus, }


description: Called when the Setup button is clicked.

code: WidgetArgsType & OnSetupClicked &40; const FSimpleDelegate & InDelegate &41;


description: Name of the platform.

code: WidgetArgsType & PlatformName &40; FText InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SPlatformSetupMessage >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > GetReadyToGoAttribute() const


description: Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


className: SPlatformSetupMessage

code: class SPlatformSetupMessage : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Constructs the widget.

code: void Construct ( const [FArguments](API\Developer\SharedSettingsWidgets\SSettingsEditorCheckoutNotice\FArguments) & InArgs )


description: Called to get the filename of the config file for display

code: WidgetArgsType & ConfigFilePath &40; const TAttribute< FString > & InAttribute &41;


description: Called when the the file was probably modified externally (only detects files that were 'ready to go' and are now not, e.g., reverted/checked in or files with the read-only flag edited outside)

code: WidgetArgsType & OnFileProbablyModifiedExternally &40; const FSimpleDelegate & InDelegate &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SSettingsEditorCheckoutNotice >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Force an update on the next tick.

code: void Invalidate()


description: Return true if the watched file can be modified (as of the last update)

code: bool IsUnlocked() const


className: SSettingsEditorCheckoutNotice

description: Implements a widget that provides a notice for files that need to be checked out.

code: class SSettingsEditorCheckoutNotice : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


className: ESkeletalMeshNotifyType

module: SkeletalMeshUtilitiesCommon

code: enum ESkeletalMeshNotifyType { BonesAdded, BonesRemoved, BonesMoved, BonesSelected, BonesRenamed, HierarchyChanged, }


className: FInlineReductionDataParameter

description: Helper struct to define inline data when applying morph target on a reduce LOD. Inline data is needed when reduction is inline (LOD reduce itself).

code: struct FInlineReductionDataParameter

InlineOriginalSrcModel

type: FSkeletalMeshLO...

InlineOriginalSrcMorphTargetData

type: TMap<FString, ...


description: Before building skeletalmesh base LOD (LOD index 0) using MeshUtilities.BuildSkeletalMesh, we want to adjust the imported faces material index to point on the correct sk material. We use the material name to match the material.

code: static void AdjustImportDataFaceMaterialIndex ( const [TArray](API\Runtime\Core\Containers\TArray)< [FSkeletalMaterial](API\Runtime\Engine\Engine\FSkeletalMaterial) > & Materials, [TArray](API\Runtime\Core\Containers\TArray)< [SkeletalMeshImportData::FMaterial](API\Runtime\Engine\Rendering\FMaterial) > & RawMeshMaterials, [TArray](API\Runtime\Core\Containers\TArray)< [SkeletalMeshImportData::FMeshFace](API\Runtime\Engine\Rendering\FMeshFace) > & LODFaces, int32 LODIndex )


description: Build the morph targets for the specified LOD. The function use the Morph target data stored in theFSkeletalMeshImportDataImportData structure

code: static void BuildMorphTargets ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, class [FSkeletalMeshImportData](API\Runtime\Engine\Rendering\FSkeletalMeshImportData) & ImportData, int32 LODIndex, bool ShouldImportNormals, bool ShouldImportTangents, bool bUseMikkTSpace, const [FOverlappingThresholds](API\Runtime\Engine\FOverlappingThresholds) & Thresholds )


description: Structure to pass all the needed parameters to do match the material when importing a skeletal mesh LOD.

type: constTArray<F...

ImportedMaterials

type: constTArray<S...

SkeletalMesh

type: USkeletalMesh&...


description: When any skeletalmesh LOD get imported or re-imported, we want to have common code to set all materials data. In case we re-import a LOD this code will match the sections using imported material name to be able to keep any section data. The material slot array is not re-order even if we re-import the base LOD.

code: static void MatchImportedMaterials ( [FSkeletalMeshMatchImportedMaterialsParameters](API\Developer\SkeletalMeshUtilitiesCommon\FLODUtilities\FSkeletalMeshMat-) & Parameters )


description: Process and update the vertex Influences using the predefined wedges

code: static void ProcessImportMeshInfluences ( const int32 WedgeCount, [TArray](API\Runtime\Core\Containers\TArray)< [SkeletalMeshImportData::FRawBoneInfluence](API\Runtime\Engine\Rendering\FRawBoneInfluence) > & Influences, const [FString](API\Runtime\Core\Containers\FString) & MeshName )