className: FPluginDescriptor

description: Descriptor for plugins. Contains all the information contained within a .uplugin file.

code: struct FPluginDescriptor

AdditionalFieldsToWrite

description: Additional fields to write

bCanContainContent

description: Can this plugin contain content?

bCanContainVerse

description: Can this plugin contain Verse code?

bEnableVerseAssetReflection

description: If to generate Verse source code definitions from assets contained in this plugin

bExplicitlyLoaded

description: When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.

bHasExplicitPlatforms

description: When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions

bInstalled

description: Signifies that the plugin was installed on top of the engine

bIsBetaVersion

description: Marks the plugin as beta in the UI

bIsExperimentalVersion

description: Marks the plugin as experimental in the UI

bIsHidden

description: For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.

bIsPluginExtension

description: If true, this plugin from a platform extension extending another plugin

bIsSealed

description: Prevents other plugins from depending on this plugin.

bNoCode

description: Prevents this plugin from containing code or modules.

bRequiresBuildPlatform

description: For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available

CachedJson

type: TSharedPtr<FJs...

description: Cached json for custom data

Category

description: The name of the category this plugin

CreatedBy

description: The company or individual who created this plugin.

CreatedByURL

description: Hyperlink URL string for the company or individual who created this plugin. This is optional.

Description

description: Description of the plugin

DisallowedPlugins

description: Plugins that cannot be used by this plugin

DocsURL

description: Documentation URL string.

EditorCustomVirtualPath

description: Optional custom virtual path to display in editor to better organize.

EnabledByDefault

type: EPluginEnabledB...

description: Whether this plugin should be enabled by default for all projects

EngineVersion

description: Version of the engine that this plugin is compatible with

FriendlyName

description: Friendly name of the plugin

LocalizationTargets

type: TArray<FLocali...

description: List of all localization targets associated with this plugin

MarketplaceURL

description: Marketplace URL for this plugin.

Modules

type: TArray<FModule...

description: List of all modules associated with this plugin

ParentPluginName

description: If specified, this is the real plugin that this one is just extending

Plugins

type: TArray<FPlugin...

description: Plugins used by this plugin

PostBuildSteps

type: FCustomBuildSte...

description: Post-build steps for each host platform

PreBuildSteps

description: Pre-build steps for each host platform

SupportedPrograms

description: List of programs that are supported by this plugin.

SupportedTargetPlatforms

description: Controls a subset of platforms that can use this plugin, and which ones will stage the .uplugin file and content files.

SupportURL

description: Support URL/email for this plugin.

VersePath

description: The Verse path to the root of this plugin's content directory

VerseScope

description: Origin/visibility of Verse code in this plugin's Content/Verse folder

Version

description: Version number for the plugin.

VersionName

description: Name of the version for this plugin.


description: Loads the descriptor from the given file.

module: Projects

code: bool Load ( const [FString](API\Runtime\Core\Containers\FString) & FileName, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Reads the descriptor from the given JSON object

code: bool Read ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


className: FPluginManifestEntry

description: Descriptor for plugins. Contains all the information contained within a .uplugin file.

code: struct FPluginManifestEntry

Descriptor

type: FPluginDescript...

description: The plugin descriptor

File

type: FString

description: Normalized path to the plugin file


className: FPluginManifest

description: Manifest of plugins. Descriptor for plugins. Contains all the information contained within a .uplugin file.

code: struct FPluginManifest

Contents

description: List of plugins in this manifest


description: Determines whether the plugin is enabled for the given target

code: bool IsEnabledForTarget ( EBuildTargetType TargetType ) const


description: Determines whether the plugin is enabled for the given platform

code: bool IsEnabledForPlatform ( const [FString](API\Runtime\Core\Containers\FString) & Platform ) const


description: Determines whether the plugin is enabled for the given target configuration

code: bool IsEnabledForTargetConfiguration ( EBuildConfiguration Configuration ) const


description: Determines if the referenced plugin is supported for the given platform

code: bool IsSupportedTargetPlatform ( const [FString](API\Runtime\Core\Containers\FString) & Platform ) const


code: bool Read ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & Object, [FText](API\Runtime\Core\Internationalization\FText) * OutFailReason )


description: Gets the string value for a given key by first looking into AdditionalFieldsToWrite and then CachedJson

code: bool GetAdditionalStringField ( const [FString](API\Runtime\Core\Containers\FString) & Key, [FString](API\Runtime\Core\Containers\FString) & OutValue ) const


description: Deprecated* Use Read(const TSharedRef&) instead.

code: bool Read ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, [FText](API\Runtime\Core\Internationalization\FText) * OutFailReason, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > ObjectPtr )


code: bool Read ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > ObjectPtr )


description: Reads an array of modules from the given JSON object

code: static bool ReadArray ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, const TCHAR * Name, [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & OutModules, [FText](API\Runtime\Core\Internationalization\FText) * OutFailReason )


code: static bool ReadArray ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, const TCHAR * Name, [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & OutModules, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Updates an array of plugin references in the specified JSON field (indexed by plugin name)

code: static void UpdateArray ( [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & JsonObject, const TCHAR * ArrayName, const [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & Plugins )


description: Updates the given json object with values in this descriptor

code: void UpdateJson ( [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & JsonObject ) const


description: Writes a descriptor to JSON

code: void Write ( TJsonWriter<> & Writer ) const


description: Writes an array of plugin references to JSON

code: static void WriteArray ( TJsonWriter<> & Writer, const TCHAR * ArrayName, const [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & Plugins )


description: Constructor

code: FPluginReferenceDescriptor ( const [FString](API\Runtime\Core\Containers\FString) & InName, bool bInEnabled )


className: FPluginReferenceDescriptor

description: Descriptor for a plugin reference. Contains the information required to enable or disable a plugin for a given platform.

code: struct FPluginReferenceDescriptor

AdditionalFieldsToWrite

type: TMap<FString, ...

description: Additional fields to write

bEnabled

type: bool

description: Whether it should be enabled by default

bHasExplicitPlatforms

description: When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions

bOptional

description: Whether this plugin is optional, and the game should silently ignore it not being present

CachedJson

description: Cached json for custom data

Description

description: Description of the plugin for users that do not have it installed.

MarketplaceURL

description: URL for this plugin on the marketplace, if the user doesn't have it installed.

Name

description: Name of the plugin

PlatformAllowList

type: TArray<FString...

description: If enabled, list of platforms for which the plugin should be enabled (or all platforms if blank).

PlatformDenyList

description: If enabled, list of platforms for which the plugin should be disabled.

RequestedVersion

type: TOptional< int3...

description: When set, specifies a specific version of the plugin that this references.

SupportedTargetPlatforms

description: The list of supported target platforms for this plugin.

TargetAllowList

type: TArray< EBuildT...

description: If enabled, list of targets for which the plugin should be enabled (or all targets if blank).

TargetConfigurationAllowList

type: TArray< EBuildC...

description: If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank).

TargetConfigurationDenyList

description: If enabled, list of target configurations for which the plugin should be disabled.

TargetDenyList

description: If enabled, list of targets for which the plugin should be disabled.


description:
Adds a directory to the additional plugin directories list.
whether the plugin directory list was changed

code: bool AddPluginDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


description:
Adds a directory to the additional root directories list.
whether the root directory list was changed

code: bool AddRootDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


description: Finds the index of a plugin in the references array

code: int32 FindPluginReferenceIndex ( const [FString](API\Runtime\Core\Containers\FString) & PluginName ) const


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


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


description: Returns the extension used for project descriptors (uproject)


description: Returns whether the project has a module of the given name

code: bool HasModule ( [FName](API\Runtime\Core\UObject\FName) ModuleName ) const


description: Checks whether the descriptor is signed

code: bool IsSigned ( const [FString](API\Runtime\Core\Containers\FString) & FilePath ) const


description: Loads the descriptor from the given file.

code: bool Load ( const [FString](API\Runtime\Core\Containers\FString) & FileName, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Reads the descriptor from the given JSON object

code: bool Read ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object, const [FString](API\Runtime\Core\Containers\FString) & PathToProject, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description:
Removes the directory from the list to scan
whether the plugin directory list was changed

code: bool RemovePluginDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


description: Saves the descriptor to the given file.

code: bool Save ( const [FString](API\Runtime\Core\Containers\FString) & FileName, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Signs the project given for the given filename

code: void Sign ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Updates the supported target platforms list

code: void UpdateSupportedTargetPlatforms ( const [FName](API\Runtime\Core\UObject\FName) & InPlatformName, bool bIsSupported )


description: Writes the descriptor to the given JSON object

code: void Write ( TJsonWriter<> & Writer, const [FString](API\Runtime\Core\Containers\FString) & PathToProject ) const


description: Constructor.

code: FProjectDescriptor()


className: FPluginStatus

description: Simple data structure that is filled when querying information about plug-ins.

code: struct FPluginStatus

bIsEnabled

description: True if plug-in is currently enabled.

Descriptor

description: The plugin descriptor

LoadedFrom

type: EPluginLoadedFr...

description: Where the plugin was loaded from

Name

description: The name of this plug-in.

PluginDirectory

description: Path to plug-in directory on disk.


className: FProjectDescriptor

description: Descriptor for projects. Contains all the information contained within a .uproject file.

code: struct FProjectDescriptor

bDisableEnginePluginsByDefault

description: Indicates that enabled by default engine plugins should not be enabled unless explicitly enabled by the project or target files.

bIsEnterpriseProject

description: Indicates if this project is an Enterprise project

Category

description: Category to show under the project browser

Description

description: Description to show in the project browser

EngineAssociation

description: The engine to open this project with.

EpicSampleNameHash

description: A hash that is used to determine if the project was forked from a sample

FileVersion

type: EProjectDescrip...

description: Descriptor version number.

Modules

description: List of all modules associated with this project

Plugins

description: List of plugins for this project (may be enabled/disabled)

PostBuildSteps

description: Custom steps to execute after building targets in this project

PreBuildSteps

description: Custom steps to execute before building targets in this project

TargetPlatforms

type: TArray<FName>

description: Array of platforms that this project is targeting


description:
Removes the directory from the list to scan
whether the root directory list was changed

code: bool RemoveRootDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


description: Check to see if the given platform name is supported as a target by the current project

code: bool IsTargetPlatformSupported ( const [FName](API\Runtime\Core\UObject\FName) & InPlatformName, const bool bAllowSupportedIfEmptyList ) const


description: Check to see if the given the current project supports all platforms

code: bool SupportsAllPlatforms() const


className: FProjectStatus

description: Simple data structure that is filled when querying information about projects

code: class FProjectStatus

bCodeBasedProject

description: True if the project is code-based

bRequiresUpdate

description: True if this project needs to be updated

bSignedSampleProject

description: True if this project is a sample provided by epic

Category

description: The UI category of this project

Description

description: The description of this project

Name

description: The name of this project


description:
Determines if the plugin can contain content.
True if the plugin can contain content.

code: bool CanContainContent() const


description:
Determines if the plugin can contain Verse code.
True if the plugin can contain Verse code.

code: bool CanContainVerse() const


description:
Get a filesystem path to the plugin's directory.
Filesystem path to the plugin's base directory.


description:
Get a filesystem path to the plugin's content directory.
Filesystem path to the plugin's content directory.


description:
Gets the plugin's descriptor
Reference to the plugin's descriptor

code: const [FPluginDescriptor](API\Runtime\Projects\FPluginDescriptor) & GetDescriptor() const


description:
Get a filesystem path to the plugin's descriptor
Filesystem path to the plugin's descriptor.

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


description:
Gets the cached plugin descriptor json
Reference to the cached plugin descriptor json

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & GetDescriptorJson()


code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetExtensionBaseDirs() const


description: Return plugin friendly name if available or the same name asGetName()otherwise.

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


description:
Get the virtual root path for assets.
The mounted root path for assets in this plugin's content folder; typically /PluginName/.


description:
Returns the plugin's location
Where the plugin was loaded from

code: EPluginLoadedFrom GetLoadedFrom() const


description:
Gets the plugin name.
Name of the plugin.

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


description:
Gets the type of a plugin
The plugin type

code: EPluginType GetType() const


description:
Determines if the plugin is enabled.
True if the plugin is currently enabled.

code: bool IsEnabled() const


description:
Gets the Verse path to the root of the plugin's content directory
Verse path to the root of the plugin's content directory

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


description:
Determines if the plugin is enabled by default.
True if the plugin is currently enabled by default.

code: bool IsEnabledByDefault ( bool bAllowEnginePluginsEnabledByDefault ) const


description: Virtual destructor

code: virtual ~IPlugin()


description:
Determines if the plugin is should be displayed in-editor for the user to enable/disable freely.
True if the plugin should be hidden.

code: bool IsHidden() const


description:
Updates the plugin's descriptor
True if the descriptor was updated, false otherwise.

code: bool UpdateDescriptor ( const [FPluginDescriptor](API\Runtime\Projects\FPluginDescriptor) & NewDescriptor, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description:
Stores the specified path, utilizing it in future search passes when searching for available plugins. Optionally refreshes the manager after the new path has been added.
Whether the plugin search path was modified

code: bool AddPluginSearchPath ( const [FString](API\Runtime\Core\Containers\FString) & ExtraDiscoveryPath, bool bRefresh )


className: IPlugin

description: Information about an enabled plugin.

code: class IPlugin


description:
Adds a single plugin to the list of plugins. Faster than refreshing all plugins withRefreshPluginsList()when you only want to add one. Does nothing if already in the list.
True if the plugin was added or already in the list. False if it failed to load.

code: bool AddToPluginsList ( const [FString](API\Runtime\Core\Containers\FString) & PluginFilename, [FText](API\Runtime\Core\Internationalization\FText) * OutFailReason )


description:
Finds information for a plugin.
Pointer to the plugin's information, or nullptr.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > FindPlugin ( const FStringView Name )


description:
Checks if all the required plug-ins are available. If not, will present an error dialog the first time a plug-in is loaded or this function is called.
true if all the required plug-ins are available.

code: bool AreRequiredPluginsAvailable()


description:
Checks whether modules for the enabled plug-ins are up to date.
true if the enabled plug-in modules are up to date.

code: bool CheckModuleCompatibility ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncompatibleModules, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncompatibleEngineModules )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > FindPlugin ( const ANSICHAR * Name )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > FindPluginFromPath ( const [FString](API\Runtime\Core\Containers\FString) & PluginPath )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > FindPluginFromDescriptor ( const [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) & PluginDesc )


description: Finds all plugin descriptors underneath a given directory (recursively)

code: void FindPluginsUnderDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Directory, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPluginFilePaths )


className: FNewPluginMountedEvent

description: Event signature for being notified that a new plugin has been mounted

code: class FNewPluginMountedEvent : public TBaseMulticastDelegate_OneParam< void, IPlugin & >


className: FLoadingModulesForPhaseEvent

description: Callback for when modules for whenLoadModulesForEnabledPlugins()completes loading for a specific phase.

code: class FLoadingModulesForPhaseEvent : public TBaseMulticastDelegate_TwoParams< void, ELoadingPhase::Type, bool >


className: FRegisterMountPointDelegate

description: Delegate type for mounting content paths. Used internally byFPackageNamecode.

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


className: FUpdatePackageLocalizationCacheDelegate

description: Delegate type for updating the package localization cache. Used internally byFPackageLocalizationManagercode.

code: typedef TBaseDelegate_NoParams< void > FUpdatePackageLocalizationCacheDelegate


description: Returns the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories).

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetAdditionalPluginSearchPaths() const


description:
Static: Access singleton instance.
Reference to the singleton object.

code: static [IPluginManager](API\Runtime\Projects\Interfaces\IPluginManager) & Get()


description:
Gets an array of all the discovered plugins.
Array of the discovered plugins.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetDiscoveredPlugins()


description: Returns the set of built-in plugin names

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetBuiltInPluginNames() const


description: Gets an array of all enabled plugins that can have content or Verse code.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetEnabledPluginsWithContentOrVerse() const


description:
Gets an array of all the enabled plugins.
Array of the enabled plugins.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetEnabledPlugins()


description:
Gets an array of all enabled plugins that can have content.
Array of plugins with IsEnabled() and CanContainContent() both true.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetEnabledPluginsWithContent() const


description:
Gets an array of all enabled plugins that can have Verse code.
Array of plugins with IsEnabled() and CanContainVerse() both true.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetEnabledPluginsWithVerse() const


description: Returns the plugin that owns the specified module, if any

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > GetModuleOwnerPlugin ( [FName](API\Runtime\Core\UObject\FName) ModuleName ) const


description: Returns the highest loading phase that has so far completed


description: Get the localization paths for all enabled plugins.

code: void GetLocalizationPathsForEnabledPlugins ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutLocResPaths )


code: bool GetPluginDependencies_FromDescriptor ( const [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) & PluginDescriptor, [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & PluginDependencies )


description: Tries to get a list of plugin dependencies for a given plugin. Returns false if the plugin provided was not found

code: bool GetPluginDependencies ( const [FString](API\Runtime\Core\Containers\FString) & PluginName, [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & PluginDependencies )


code: bool GetPluginDependencies_FromFileName ( const [FString](API\Runtime\Core\Containers\FString) & PluginFileName, [TArray](API\Runtime\Core\Containers\TArray)< [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) > & PluginDependencies )


description: Gets an array of plugins that loaded their own content pak file

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPlugin](API\Runtime\Projects\Interfaces\IPlugin) > > GetPluginsWithPakFile() const


description: Scans a set of given plugins and adds them to the passed in ConfigSystem so that the runtime can load faster without needing to scan all plugins looking for config/paks

code: bool IntegratePluginsIntoConfig ( [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) & ConfigSystem, const TCHAR * EngineIniName, const TCHAR * PlatformName, const TCHAR * StagedPluginsFile )


description: Loads all plug-ins

code: bool LoadModulesForEnabledPlugins ( const [ELoadingPhase::Type](API\Runtime\Projects\ELoadingPhase__Type) LoadingPhase )


code: bool MountExplicitlyLoadedPlugin_FromFileName ( const [FString](API\Runtime\Core\Containers\FString) & PluginFileName )


code: bool MountExplicitlyLoadedPlugin_FromDescriptor ( const [FPluginReferenceDescriptor](API\Runtime\Projects\FPluginReferenceDescriptor) & PluginDescriptor )


description: Marks an explicitly loaded plugin as enabled, mounts its content and tries to load its modules. These plugins are not loaded implicitly, but instead wait for this function to be called.

code: bool MountExplicitlyLoadedPlugin ( const [FString](API\Runtime\Core\Containers\FString) & PluginName )


description: Marks a newly created plugin as enabled, mounts its content and tries to load its modules

code: void MountNewlyCreatedPlugin ( const [FString](API\Runtime\Core\Containers\FString) & PluginName )


description: Event signature for being notified that a new plugin has been created


description: Event for being notified that a new plugin has been mounted


description: Event for being notified that a plugin has been edited


description: Event for being notified that a plugin has been unmounted


description: Does a reverse lookup to try to figure out what theUObjectpackage name is for a plugin

code: [FName](API\Runtime\Core\UObject\FName) PackageNameFromModuleName ( [FName](API\Runtime\Core\UObject\FName) ModuleName )


description: Updates the list of plugins.

code: void RefreshPluginsList()


description:
Remove a single plugin from the list of plugins.
True if the plugin was not in the list. False if it can't be removed (see OutFailReason).

code: bool RemoveFromPluginsList ( const [FString](API\Runtime\Core\Containers\FString) & PluginFilename, [FText](API\Runtime\Core\Internationalization\FText) * OutFailReason )


description:
Determines if a content-only project requires a temporary target due to having a plugin enabled
True if the project requires a temp target to be generated

code: bool RequiresTempTargetForCodePlugin ( const [FProjectDescriptor](API\Runtime\Projects\FProjectDescriptor) * ProjectDescriptor, const [FString](API\Runtime\Core\Containers\FString) & Platform, EBuildConfiguration Configuration, EBuildTargetType TargetType, [FText](API\Runtime\Core\Internationalization\FText) & OutReason )


description: Set root directories for where to find binaries for plugins.

code: void SetBinariesRootDirectories ( const [FString](API\Runtime\Core\Containers\FString) & EngineBinariesRootDir, const [FString](API\Runtime\Core\Containers\FString) & ProjectBinariesRootDir )


description: If preload binaries is set all plugin binaries will be loaded in an early Loading phase. This is a temporary solution to work around issues with pak/iostore for modular builds

code: void SetPreloadBinaries()


description: Sets the delegate to call to register a new content mount point. This is used internally by the plug-in manager system and should not be called by you. This is registered at application startup byFPackageNamecode in CoreUObject.

code: void SetRegisterMountPointDelegate ( const [FRegisterMountPointDelegate](API\Runtime\Projects\Interfaces\IPluginManager\FRegisterMountPointDelegate) & Delegate )


description: Sets the delegate to call to unregister a new content mount point. This is used internally by the plug-in manager system and should not be called by you. This is registered at application startup byFPackageNamecode in CoreUObject.

code: void SetUnRegisterMountPointDelegate ( const [FRegisterMountPointDelegate](API\Runtime\Projects\Interfaces\IPluginManager\FRegisterMountPointDelegate) & Delegate )


description: Sets the delegate to call to update the package localization cache. This is used internally by the plug-in manager system and should not be called by you. This is registered at application startup byFPackageLocalizationManagercode in CoreUObject.

code: void SetUpdatePackageLocalizationCacheDelegate ( const [FUpdatePackageLocalizationCacheDelegate](API\Runtime\Projects\Interfaces\IPluginManager\FUpdatePackageLo-) & Delegate )


description: Marks an explicitly loaded plugin as disabled, unmounts its content (does not work on plugins with compiled modules).

code: bool UnmountExplicitlyLoadedPlugin ( const [FString](API\Runtime\Core\Containers\FString) & PluginName, [FText](API\Runtime\Core\Internationalization\FText) * OutReason )


className: IPluginManager

description: PluginManager manages available code and content extensions (both loaded and not loaded).

code: class IPluginManager


description: Suppress project file writes.

code: void AddSuppressProjectFileWrite ( const [FName](API\Runtime\Core\UObject\FName) InName )


description:
Checks if the modules for a project are up to date
false if UBT needs to be run to recompile modules for a project.

code: bool CheckModuleCompatibility ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncompatibleModules )


description: Clear the list of supported target platforms for the target project

code: void ClearSupportedTargetPlatformsForProject ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Clear the list of supported target platforms for the current project


description: Callback for when modules for whenLoadModulesForProject()completes loading for a specific phase.

code: class FLoadingModulesForPhaseEvent : public TBaseMulticastDelegate_TwoParams< void, ELoadingPhase::Type, bool >


description: Called when the target platforms for the current project are changed

code: typedef TMulticastDelegate_NoParams< void > FOnTargetPlatformsForCurrentProjectChangedEvent


description:
Static: Access singleton instance
Reference to the singleton object

code: static [IProjectManager](API\Runtime\Projects\Interfaces\IProjectManager) & Get()


description: Returns the list of additional directories to be scanned for plugins (aside from the engine and project plugin directories).

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


description:
This is NOT the name of the recently loaded .uproject file.
File name.

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


description: Access array used to cache current project's list of module context infos

code: [TArray](API\Runtime\Core\Containers\TArray)< [FModuleContextInfo](API\Runtime\Projects\FModuleContextInfo) > & GetCurrentProjectModuleContextInfos()


description:
Gets the current project descriptor.
Pointer to the currently loaded project descriptor. NULL if none is loaded.

code: const [FProjectDescriptor](API\Runtime\Projects\FProjectDescriptor) * GetCurrentProject() const


description:
Checks whether the current project has default settings for plugins (ie. does not enable any new plugins, or disable any default plugins)
True if the project has the default plugin settings.

code: bool HasDefaultPluginSettings() const


description: Checks whether the current loaded project has been modified but not saved to disk

code: bool IsCurrentProjectDirty() const


description:
Gets the enterprise flag value on the current project
True if the project is an Enterprise project

code: bool IsEnterpriseProject()


description: Returns true if project file write should be suppressed.


description: Loads all modules for the currently loaded project in the specified loading phase

code: bool LoadModulesForProject ( const [ELoadingPhase::Type](API\Runtime\Projects\ELoadingPhase__Type) LoadingPhase )


description: GetLoadedGameProjectFile

code: bool LoadProjectFile ( const [FString](API\Runtime\Core\Containers\FString) & ProjectFile )


description:
Gets status about the current project
true if the file was successfully open and read

code: bool QueryStatusForCurrentProject ( [FProjectStatus](API\Runtime\Projects\Interfaces\FProjectStatus) & OutProjectStatus ) const


description:
Gets status about the specified project
true if the file was successfully open and read

code: bool QueryStatusForProject ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, [FProjectStatus](API\Runtime\Projects\Interfaces\FProjectStatus) & OutProjectStatus ) const


code: bool RemovePluginReference ( const [FString](API\Runtime\Core\Containers\FString) & PluginName, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Removes suppression of project file writes.

code: void RemoveSuppressProjectFileWrite ( const [FName](API\Runtime\Core\UObject\FName) InName )


description:
Saves the current project to the project path
True if the project was saved successfully

code: bool SaveCurrentProjectToDisk ( [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description: Sets the enterprise flag value on the current project

code: void SetIsEnterpriseProject ( bool bValue )


description:
UseIsCurrentProjectDirty()to tell whether the project was actually modified.
False on failure to update the current project descriptor.

code: bool SetPluginEnabled ( const [FString](API\Runtime\Core\Containers\FString) & PluginName, bool bEnabled, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description:
Sets the project's EpicSampleNameHash (based on its filename) and category, then saves the file to disk. This marks the project as a sample and fixes its filename so that it isn't mistaken for a sample if a copy of the file is made.
true if the file was successfully updated and saved to disk

code: bool SignSampleProject ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, const [FString](API\Runtime\Core\Containers\FString) & Category, [FText](API\Runtime\Core\Internationalization\FText) & OutFailReason )


description:
Updates a directory to be scanned for plugins (added or removed)
Whether the plugin directory list was changed.

code: bool UpdateAdditionalPluginDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir, const bool bAddOrRemove )


description: Update the list of supported target platforms for the target project based upon the parameters provided

code: void UpdateSupportedTargetPlatformsForProject ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, const [FName](API\Runtime\Core\UObject\FName) & InPlatformName, const bool bIsSupported )


description: Update the list of supported target platforms for the current project based upon the parameters provided

code: void UpdateSupportedTargetPlatformsForCurrentProject ( const [FName](API\Runtime\Core\UObject\FName) & InPlatformName, const bool bIsSupported )


className: IProjectManager

description: ProjectAndPluginManager manages available code and content extensions (both loaded and not loaded.)

code: class IProjectManager


description: Compares this property path to a string

module: PropertyPath

code: bool Equals ( const [FString](API\Runtime\Core\Containers\FString) & Other ) const


description: Get the cached address for this property path, if any

code: void * GetCachedAddress() const


description: Get the cached container for this property path, for checking purposes

code: void * GetCachedContainer() const


description: Get cached last container property in path

code: void * GetCachedLastContainerInPath() const


description: Get the cached function for this property path, if any

code: [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * GetCachedFunction() const


description: Get cached index of last container property in path, INDEX_NONE if last container is not in path


description: ReturnsFPropertyif valid. This can beUFunction

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetFProperty() const


description:
Get the path segment at the end of the path
the segment at the specified index

code: const [FPropertyPathSegment](API\Runtime\PropertyPath\FPropertyPathSegment) & GetLastSegment() const


description: Get the number of segments in this path

code: int32 GetNumSegments() const


description:
Get the path segment at the specified index
the segment at the specified index

code: const [FPropertyPathSegment](API\Runtime\PropertyPath\FPropertyPathSegment) & GetSegment ( int32 InSegmentIndex ) const


description:
Check whether a path is fully resolved. This means that it has a cached address and does not resolve over an object boundary or a dynamic array.
true if the path is fully resolved

code: bool IsFullyResolved() const


description:
Check whether a path is resolved. This means that it has a cached address, but may resolve over an object boundary or a dynamic array.
true if the path is resolved

code: bool IsResolved() const


description: Check whether this property path is non-empty

code: bool IsValid() const


description: Make a new property path from a string

code: void MakeFromString ( const [FString](API\Runtime\Core\Containers\FString) & InPropertyPath )


description: Make a copy which is unresolved

code: static [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) MakeUnresolvedCopy ( const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & ToCopy )


description: Compares this property path to a string

code: bool operator== ( const [FString](API\Runtime\Core\Containers\FString) & Other ) const


description: Trims this property path at the end

code: void RemoveFromEnd ( int32 InNumSegments )


description: Trims this property path at the start

code: void RemoveFromStart ( int32 InNumSegments )


description:
Resolve this property path against the specified object.
true if the path could be resolved

code: bool Resolve ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer ) const


description: Cache a resolved address for faster subsequent access

code: void ResolveLeaf ( void * InAddress ) const


description: Cache a resolved function for faster subsequent access

code: void ResolveLeaf ( [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * InFunction ) const


description: Set the cached container for this property path, for checking purposes

code: void SetCachedContainer ( void * InContainer ) const


description: Update cached last container property in path & correspondng index, invalidates 'bCanSafelyUsedCachedAddress'

code: void SetCachedLastContainer ( void * InContainer, int32 InIndex ) const


description: Set whether this path resolves over object or dynamic array boundaries, making it unsafe for general direct cached access

code: void SetCanSafelyUsedCachedAddress ( bool bInCanSafelyUsedCachedAddress ) const


description: Convert this property path to aFEditPropertyChain. Note that the path must be resolved.

code: void ToEditPropertyChain ( [FEditPropertyChain](API\Runtime\CoreUObject\UObject\FEditPropertyChain) & OutPropertyChain ) const


description: Make a string representation of this property path


description: UStructboilerplate constructor - do not use

code: FCachedPropertyPath()


code: FCachedPropertyPath ( const [FString](API\Runtime\Core\Containers\FString) & Path )


code: FCachedPropertyPath ( const [FPropertyPathSegment](API\Runtime\PropertyPath\FPropertyPathSegment) & Segment )


code: FCachedPropertyPath ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & PathSegments )


className: FCachedPropertyPath

description: Base class for cached property paths

code: struct FCachedPropertyPath


code: static bool CallGetterFunction ( ContainerType * InContainer, [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * InFunction, T & OutValue )


description: Convert this property path to aFPropertyChangedEvent. Note that the path must be resolved.

code: [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) ToPropertyChangedEvent ( [EPropertyChangeType::Type](API\Runtime\CoreUObject\UObject\Type) InChangeType ) const


className: FCallGetterFunctionHelper

description: FCallGetterFunctionHelper< T, UObject >

code: template<typename T, typename ContainerType> struct FCallGetterFunctionHelper


className: FCallGetterFunctionHelper< T, UObject >::CallGetterFunction

code: static bool CallGetterFunction &40; UObject &42; InContainer, UFunction &42; InFunction, T & OutValue &41;


className: FCallGetterFunctionHelper< T, UObject >

description: UObjectpartial specialization ofFCallGetterFunctionHelper

code: template<typename T> struct FCallGetterFunctionHelper< T, UObject >


code: static bool CallSetterFunction ( ContainerType * InContainer, [UFunction](API\Runtime\CoreUObject\UObject\UFunction) * InFunction, const T & InValue )


className: FCallSetterFunctionHelper

description: FCallSetterFunctionHelper< T, UObject >

code: template<typename T, typename ContainerType> struct FCallSetterFunctionHelper


className: FCallSetterFunctionHelper< T, UObject >::CallSetterFunction

code: static bool CallSetterFunction &40; UObject &42; InContainer, UFunction &42; InFunction, const T & InValue &41;


code: static bool IsConcreteTypeCompatibleWithReflectedType ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property )


className: FCallSetterFunctionHelper< T, UObject >

description: UObjectpartial specialization ofFCallSetterFunctionHelper

code: template<typename T> struct FCallSetterFunctionHelper< T, UObject >


description: FConcreteTypeCompatibleWithReflectedTypeHelper< T[N]>

code: template<typename T> struct FConcreteTypeCompatibleWithReflectedTypeHelper


code: static bool IsConcreteTypeCompatibleWithReflectedType &40; FProperty &42; Property &41;


description: Static array partial specialization

code: template<typename T, int32 N> struct FConcreteTypeCompatibleWithReflectedTypeHelper< T[N]>


code: static bool GetValue ( const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty )


className: FGetValueFastHelper

description: FGetValueFastHelper< T[N]>

code: template<typename T> struct FGetValueFastHelper


className: FGetValueFastHelper< T[N]>::GetValue

code: static bool GetValue &40; const FCachedPropertyPath & InPropertyPath, T(&) OutValue, FProperty &42;& OutProperty &41;


code: static bool GetValue ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty )


className: FGetValueFastHelper< T[N]>

description: Partial specialization for arrays

code: template<typename T, int32 N> struct FGetValueFastHelper< T[N]>


className: FGetValueHelper

code: template<typename T, typename ContainerType> struct FGetValueHelper


className: FGetValueHelper< bool, ContainerType >::GetValue

code: static bool GetValue &40; ContainerType &42; InContainer, const FCachedPropertyPath & InPropertyPath, bool & OutValue, FProperty &42;& OutProperty &41;


className: FGetValueHelper< T[N], ContainerType >::GetValue

code: static bool GetValue &40; ContainerType &42; InContainer, const FCachedPropertyPath & InPropertyPath, T(&) OutValue, FProperty &42;& OutProperty &41;


className: FGetValueHelper< T[N], ContainerType >

description: Partial specialization for arrays

code: template<typename T, typename ContainerType, int32 N> struct FGetValueHelper< T[N], ContainerType >


className: FGetValueHelper< bool, ContainerType >

description: Partial specialization for bools/bitfields

code: template<typename ContainerType> struct FGetValueHelper< bool, ContainerType >


code: template<typename ContainerType> bool Resolve_Impl ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath )


code: FInternalGetterResolver ( T & InValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& InOutProperty )


className: FInternalGetterResolver

code: template<typename T> struct FInternalGetterResolver : public [PropertyPathHelpersInternal::TPropertyPathResolver< FInternalGetterResolver< T > >](API\Runtime\PropertyPath\TPropertyPathResolver)

Property

type: FProperty*...

Value

type: T &


code: FInternalSetterResolver ( const T & InValueToSet )


className: FInternalSetterResolver

code: template<typename T> struct FInternalSetterResolver : public [PropertyPathHelpersInternal::TPropertyPathResolver< FInternalSetterResolver< T > >](API\Runtime\PropertyPath\TPropertyPathResolver)

type: const T &


description:
Callbacks for a leaf segment in a property path iteration. Used to resolve the property path.
true if the iteration should continue.

code: bool Resolve ( void * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath )


code: bool Resolve ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath )


description: Virtual destructor

code: virtual ~FPropertyPathResolver()


className: FPropertyPathResolver

description: Base class for resolving property paths

code: struct FPropertyPathResolver


description: the resolved field


description: the name of this segment


description: Make a copy which is unresolved

code: static [FPropertyPathSegment](API\Runtime\PropertyPath\FPropertyPathSegment) MakeUnresolvedCopy ( const [FPropertyPathSegment](API\Runtime\PropertyPath\FPropertyPathSegment) & ToCopy )


description: the resolved struct

code: [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * GetStruct() const


description: Called after this event has been serialized in order to cache the field pointer if necessary

code: void PostSerialize ( const [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Resolves the name on the given Struct. Can be used to cache the resulting property so that future calls can be processed quickly.

code: [FFieldVariant](API\Runtime\CoreUObject\UObject\FFieldVariant) Resolve ( [UStruct](API\Runtime\CoreUObject\UObject\UStruct) * InStruct ) const


code: FPropertyPathSegment()


description: Construct from char count and storage

code: FPropertyPathSegment ( int32 InCount, const TCHAR * InString )


description: the array index of this segment

code: int32 GetArrayIndex() const


className: FPropertyPathSegment

description: Base class for cached property path segments

code: struct FPropertyPathSegment

ArrayIndex

description: The optional array index.

Name

type: FName

description: The sub-component of the property path, a single value between .'s of the path


className: FPropertySizesMatchHelper

description: FPropertySizesMatchHelper< T[N]>

code: template<typename T> struct FPropertySizesMatchHelper


code: static bool PropertySizesMatch ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty )


code: static bool PropertySizesMatch &40; FProperty &42; InProperty &41;


className: FPropertySizesMatchHelper< T[N]>

code: template<typename T, int32 N> struct FPropertySizesMatchHelper< T[N]>


code: FPropertyStructView ( const [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InScriptStruct, const uint8 * InMemory )


className: FPropertyStructView

description: Helper struct to represent a view of a struct, used to specialize behavior against

code: struct FPropertyStructView

Memory

type: const uint8 ...

ScriptStruct

type: constUScriptSt...


code: static bool SetValue ( const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue )


className: FSetValueFastHelper

code: template<typename T> struct FSetValueFastHelper


className: FSetValueFastHelper< bool >::SetValue

code: static bool SetValue &40; const FCachedPropertyPath & InPropertyPath, const bool & InValue &41;


className: FSetValueFastHelper< bool >

description: Explicit specialization for bools/bitfields

code: template<> struct FSetValueFastHelper< bool >


className: FSetValueFastHelper< T[N]>::SetValue

code: static bool SetValue &40; const FCachedPropertyPath & InPropertyPath, const T(&) InValue &41;


className: FSetValueFastHelper< T[N]>

description: Partial specialization for arrays

code: template<typename T, int32 N> struct FSetValueFastHelper< T[N]>


code: static bool SetValue ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue )


className: FSetValueHelper

code: template<typename T, typename ContainerType> struct FSetValueHelper


className: FSetValueHelper< bool, ContainerType >::SetValue

code: static bool SetValue &40; ContainerType &42; InContainer, const FCachedPropertyPath & InPropertyPath, const bool & InValue &41;


className: FSetValueHelper< bool, ContainerType >

code: template<typename ContainerType> struct FSetValueHelper< bool, ContainerType >


className: FSetValueHelper< T[N], ContainerType >::SetValue

code: static bool SetValue &40; ContainerType &42; InContainer, const FCachedPropertyPath & InPropertyPath, const T(&) InValue &41;


className: FSetValueHelper< T[N], ContainerType >

description: Partial specialization for arrays

code: template<typename T, typename ContainerType, int32 N> struct FSetValueHelper< T[N], ContainerType >


description:
Fast, unsafe version ofGetValue().
true if the value was written successfully

code: namespace PropertyPathHelpersInternal { template<typename T, typename ContainerType> bool PropertyPathHelpersInternal::GetValueFast ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty ) }


description:
Resolve a property path to a property and a value. Supports functions as input fields.
true if the address and property were resolved

code: namespace PropertyPathHelpersInternal { template<typename T, typename ContainerType> bool PropertyPathHelpersInternal::GetValue ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty, T & OutValue ) }


description:
Fast, unsafe version ofSetValue().
true if the value was read successfully

code: namespace PropertyPathHelpersInternal { template<typename T, typename ContainerType> bool PropertyPathHelpersInternal::SetValueFast ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue ) }


description: This method is specialized internally to work withFPropertyStructViewtrue if the value was resolved

code: namespace PropertyPathHelpersInternal { template<typename T, typename ContainerType> bool PropertyPathHelpersInternal::SetValue ( ContainerType * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue ) }


description:
Get the value represented by this property path. forcing the use of cached addresses whether or not the path resolves over object or dynamic array boundaries. Using this function implies that the path is resolved and has not changed since last resolution.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValueFast ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue ) }


description:
Get the value and the leaf property represented by this property path, forcing the use of cached addresses whether or not the path resolves over object or dynamic array boundaries. Using this function implies that the path is resolved and has not changed since last resolution.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValueFast ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty ) }


description:
Get the value represented by this property path. If the cached property path has a cached address it will use that as a 'fast path' instead of iterating the path. This has safety implications depending on the form of the path, so paths that are resolved over object boundaries or dynamic arrays will always use the slow path for safety.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FString](API\Runtime\Core\Containers\FString) & InPropertyPath, T & OutValue ) }


code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue ) }


description:
Get the value and the leaf property represented by this property path. If the cached property path has a cached address it will use that as a 'fast path' instead of iterating the path. This has safety implications depending on the form of the path, so paths that are resolved over object boundaries or dynamic arrays will always use the slow path for safety.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty ) }


code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::GetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FString](API\Runtime\Core\Containers\FString) & InPropertyPath, T & OutValue, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) *& OutProperty ) }


description:
Get the value represented by this property path. Fast, unsafe version. Using this function implies that the path is resolved and has not changed since last resolution.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::SetPropertyValueFast ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue ) }


description:
Set the value and the leaf property represented by this property path If the cached property path has a cached address it will use that as a 'fast path' instead of iterating the path. This has safety implications depending on the form of the path, so paths that are resolved over object boundaries or dynamic arrays will always use the slow path for safety.
true if the property value was successfully copied

code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::SetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath, const T & InValue ) }


code: namespace PropertyPathHelpers { template<typename T> bool PropertyPathHelpers::SetPropertyValue ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FString](API\Runtime\Core\Containers\FString) & InPropertyPath, const T & InValue ) }


description:
Callbacks for a leaf segment in a property path iteration. Used to resolve the property path.
true if the iteration should continue.

code: virtual bool Resolve ( void * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath )


code: virtual bool Resolve ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InContainer, const [FCachedPropertyPath](API\Runtime\PropertyPath\FCachedPropertyPath) & InPropertyPath )


className: TPropertyPathResolver

description: Recurring template allowing derived types to only implement templated Resolve_Impl

code: template<typename DerivedType> struct TPropertyPathResolver : public [PropertyPathHelpersInternal::FPropertyPathResolver](API\Runtime\PropertyPath\FPropertyPathResolver)


className: WithPostSerialize

code: enum &123; WithPostSerialize = true &125;


code: template<> struct TStructOpsTypeTraits< FPropertyPathSegment > : public [TStructOpsTypeTraitsBase2< FPropertyPathSegment >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description: Compacts materials by removing any that have no associated triangles. Also updates the material index map.

module: RawMesh

code: void CompactMaterialIndices()


description: Empties all data streams.

code: void Empty()


description: Helper for getting the position of a wedge.

code: FVector3f GetWedgePosition ( int32 WedgeIndex ) const


description: Returns true if the mesh contains valid information or slightly invalid information that we can fix.

code: bool IsValidOrFixable() const


className: FRawMesh

description: Additionally, to ease in backwards compatibility all properties should use only primitive types!

code: struct FRawMesh

FaceMaterialIndices

type: TArray< int32 >

description: Material index. Array[FaceId] = int32

FaceSmoothingMasks

type: TArray< uint32 ...

description: Smoothing mask. Array[FaceId] = uint32

MaterialIndexToImportIndex

description: Map from material index -> original material index at import time.

VertexPositions

type: TArray< FVector...

description: Position in local space. Array[VertexId] = float3(x,y,z)

WedgeColors

type: TArray<FColor...

description: Color. Array[WedgeId]=float3(r,g,b,a)

WedgeIndices

description: Indexof the vertex at this wedge. Array[WedgeId] = VertexId

WedgeTangentX

description: Tangent, U direction. Array[WedgeId] = float3(x,y,z)

WedgeTangentY

description: Tangent, V direction. Array[WedgeId] = float3(x,y,z)

WedgeTangentZ

description: Normal. Array[WedgeId] = float3(x,y,z)

WedgeTexCoords

description: Texture coordinates. Array[UVId][WedgeId]=float2(u,v)


description: Returns true if the mesh contains valid information.

code: bool IsValid() const


description: Returns true if no bulk data is available for this mesh.


code: const FByteBulkData & GetBulkData() const


description: Retrieve a string uniquely identifying the contents of this bulk data.


code: bool IsEmpty() const


description: Load the raw mesh from bulk data.

code: void LoadRawMesh ( struct [FRawMesh](API\Runtime\RawMesh\FRawMesh) & OutMesh )


description: Store a new raw mesh in the bulk data.

code: void SaveRawMesh ( struct [FRawMesh](API\Runtime\RawMesh\FRawMesh) & InMesh )


description: Serialization.

code: void Serialize ( class [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, class [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner )


description: Uses a hash as the GUID, useful to prevent creating new GUIDs on load for legacy assets.

code: void UseHashAsGuid ( class [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner )


description: Default constructor.

code: FRawMeshBulkData()


className: FRawMeshBulkData

description: Bulk data storage for raw meshes.

code: class FRawMeshBulkData


description: Reliability Module Interface

module: ReliabilityHandlerComponent

code: class FReliabilityHandlerComponentModuleInterface : public [FPacketHandlerComponentModuleInterface](API\Runtime\PacketHandler\FPacketHandlerComponentModuleInt-)


className: CrossCompiler::

description: Cross compiler support/common functionality.

module: RenderCore

code: namespace CrossCompiler { enum { PACKED_TYPENAME_HIGHP = (int32)EPackedTypeName::HighP, PACKED_TYPENAME_MEDIUMP = (int32)EPackedTypeName::MediumP, PACKED_TYPENAME_LOWP = (int32)EPackedTypeName::LowP, PACKED_TYPENAME_INT = (int32)EPackedTypeName::Int, PACKED_TYPENAME_UINT = (int32)EPackedTypeName::Uint, PACKED_TYPENAME_SAMPLER = (int32)EPackedTypeName::Sampler, PACKED_TYPENAME_IMAGE = (int32)EPackedTypeName::Image, PACKED_TYPEINDEX_HIGHP = (int32)EPackedTypeIndex::HighP, PACKED_TYPEINDEX_MEDIUMP = (int32)EPackedTypeIndex::MediumP, PACKED_TYPEINDEX_LOWP = (int32)EPackedTypeIndex::LowP, PACKED_TYPEINDEX_INT = (int32)EPackedTypeIndex::Int, PACKED_TYPEINDEX_UINT = (int32)EPackedTypeIndex::Uint, PACKED_TYPEINDEX_SAMPLER = (int32)EPackedTypeIndex::Sampler, PACKED_TYPEINDEX_IMAGE = (int32)EPackedTypeIndex::Image, PACKED_TYPEINDEX_MAX = (int32)EPackedTypeIndex::Max, } }


code: namespace CrossCompiler { enum EPackedTypeIndex { HighP = 0, MediumP = 1, LowP = 2, Int = 3, Uint = 4, Sampler = 5, Image = 6, Max = 7, Invalid = -1, } }


description: Make sure these enums match hlslcc EArray on Engine\Source\ThirdParty\hlslcc\hlslcc\src\hlslcc_lib\glsl_parser_extras.h.

code: namespace CrossCompiler { enum EPackedTypeName { HighP = 'h', MediumP = 'm', LowP = 'l', Int = 'i', Uint = 'u', Sampler = 's', Image = 'g', Invalid = ' ', } }


code: namespace CrossCompiler { enum EShaderStage { SHADER_STAGE_VERTEX = 0, SHADER_STAGE_PIXEL, SHADER_STAGE_GEOMETRY, SHADER_STAGE_HULL, SHADER_STAGE_DOMAIN, NUM_NON_COMPUTE_SHADER_STAGES, SHADER_STAGE_COMPUTE = NUM_NON_COMPUTE_SHADER_STAGES, NUM_SHADER_STAGES, } }


description: Creates an instance of this component

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [HandlerComponent](API\Runtime\PacketHandler\HandlerComponent) > CreateComponentInstance ( [FString](API\Runtime\Core\Containers\FString) & Options )


code: namespace CrossCompiler { static bool CrossCompiler::IsValidPackedTypeName ( [EPackedTypeName](API\Runtime\RenderCore\CrossCompiler__EPackedTypeName) TypeName ) }


code: namespace CrossCompiler { [FArchive](API\Runtime\Core\Serialization\FArchive) & CrossCompiler::operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FShaderBindingInOutMask](API\Runtime\RenderCore\FShaderBindingInOutMask) & BindingInOutMask ) }


code: namespace CrossCompiler { [FArchive](API\Runtime\Core\Serialization\FArchive) & CrossCompiler::operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FPackedArrayInfo](API\Runtime\RenderCore\FPackedArrayInfo) & Info ) }


code: namespace CrossCompiler { [FArchive](API\Runtime\Core\Serialization\FArchive) & CrossCompiler::operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FUniformBufferCopyInfo](API\Runtime\RenderCore\FUniformBufferCopyInfo) & Info ) }


code: namespace CrossCompiler { static uint8 CrossCompiler::PackedTypeIndexToTypeName ( uint8 ArrayType ) }


code: namespace CrossCompiler { static [EPackedTypeName](API\Runtime\RenderCore\CrossCompiler__EPackedTypeName) CrossCompiler::PackedTypeIndexToTypeName ( [EPackedTypeIndex](API\Runtime\RenderCore\CrossCompiler__EPackedTypeIndex) TypeIndex ) }


code: namespace CrossCompiler { static uint8 CrossCompiler::PackedTypeNameToTypeIndex ( uint8 ArrayName ) }


code: namespace CrossCompiler { static [EPackedTypeIndex](API\Runtime\RenderCore\CrossCompiler__EPackedTypeIndex) CrossCompiler::PackedTypeNameToTypeIndex ( [EPackedTypeName](API\Runtime\RenderCore\CrossCompiler__EPackedTypeName) TypeName ) }


code: namespace CrossCompiler { static uint8 CrossCompiler::ShaderStageIndexToTypeName ( uint8 ShaderStage ) }


className: DispatchContext

code: struct DispatchContext

DstType

type: ECopyTextureRes...

ValueType

type: ECopyTextureVal...


description: Model how the GPU costs of a budget scales with a ResolutionFraction.

code: namespace DynamicRenderScaling { enum EHeuristicModel { Unknown, Linear, Quadratic, } }


code: namespace DynamicRenderScaling { constexpr float DynamicRenderScaling::FractionToPercentage ( float Fraction ) }


code: namespace DynamicRenderScaling { float DynamicRenderScaling::GetPercentageCVarToFraction ( const [TAutoConsoleVariable](API\Runtime\Core\HAL\TAutoConsoleVariable)< float > & Percentage ) }


code: namespace DynamicRenderScaling { constexpr float DynamicRenderScaling::PercentageToFraction ( float Percentage ) }


code: namespace EShaderPrecisionModifier { enum Type { Float, Half, Fixed, Invalid, } }


description: Default Values such as MinLuminanceLog10=-4, MidLuminance=15, MaxLuminance=1000, SceneColorMultiplier=1.5.

code: FACESTonemapParams()


className: FACESTonemapParams

code: struct FACESTonemapParams

type: float


className: FAdaptiveVTDescription

description: Describes an adaptive virtual texture.

code: struct FAdaptiveVTDescription


className: FAllocatedVTDescription

description: Parameters needed to create anIAllocatedVirtualTextureDescribes both page table and physical texture size, format, and layout

code: struct FAllocatedVTDescription

type: union FAllocate...

bPrivateSpace

type: uint8:  1

description: Should the AllocatedVT create its own dedicated page table allocation? Can be useful to control total allocation.

bShareDuplicateLayers

description: If the AllocatedVT has the same producer mapped to multiple layers, should those be merged into a single page table layer? This can make for more efficient page tables when enabled, but certain code may make assumption that number of layers specified when allocating VT exactly matches the resulting page page

ProducerHandle

type: FVirtualTexture...

description: Producer for each texture layer.

ProducerLayerIndex

description: Local layer inside producer for each texture layer.


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: static RENDERCORE_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: RENDERCORE_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FARGB16BigConvertPS](API\Runtime\RenderCore\FARGB16BigConvertPS) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: void SetParameters ( [FRHIBatchedShaderParameters](API\Runtime\RHI\FRHIBatchedShaderParameters) & BatchedParameters, FShaderResourceViewRHIRef SRV, const FIntPoint & OutputDimensions, [UE::Color::EEncoding](API\Runtime\ColorManagement\UE__Color__EEncoding) Encoding, const FMatrix44f & CSTransform )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static RENDERCORE_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FARGB16BigConvertPS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


description: This shader expects a single texture in PF_R16G16B16A16_UINT format.

code: class FARGB16BigConvertPS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FAYUVConvertPS](API\Runtime\RenderCore\FAYUVConvertPS) >::Type InternalBaseType


code: void SetParameters ( [FRHIBatchedShaderParameters](API\Runtime\RHI\FRHIBatchedShaderParameters) & BatchedParameters, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< FRHITexture2D > AYUVTexture, const FMatrix & ColorTransform, const FVector & YUVOffset, bool SrgbToLinear )


code: FAYUVConvertPS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FAYUVConvertPS

description: This shader expects a single texture consisting of a N x M array of pixels in AYUV format. Each pixel is encoded as four consecutive unsigned chars with the following layout: [V0 U0 Y0 A0][V1 U1 Y1 A1]..

code: class FAYUVConvertPS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


code: static constexpr int CounterBase = __COUNTER__;


className: DefineName

code: static DefineName = TEXT( "ALPHA" );


className: FALPHA

code: class FALPHA : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters

BinkParameters

type: FBinkParameters...


code: static DefineName = TEXT( "ST2084" );


code: static DefineName = TEXT( "TONEMAP" );


className: FTONEMAP

description: class FMyShaderDim : SHADER_PERMUTATION_BOOL("MY_SHADER_DEFINE_NAME");

code: class FTONEMAP : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static RENDERCORE_API [ShaderMetaType](API\Runtime\RenderCore\FBinkDrawICtCpPS\ShaderMetaType) & GetStaticType()


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FBinkDrawICtCpPS](API\Runtime\RenderCore\FBinkDrawICtCpPS) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: class FST2084 : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: RENDERCORE_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: static bool ShouldCompilePermutation ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static RENDERCORE_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FBinkDrawICtCpPS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FBinkDrawICtCpPS

code: struct FBinkDrawICtCpPS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static RENDERCORE_API [ShaderMetaType](API\Runtime\RenderCore\FBinkDrawVS\ShaderMetaType) & GetStaticType()


code: RENDERCORE_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FBinkDrawVS](API\Runtime\RenderCore\FBinkDrawVS) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static bool ShouldCompilePermutation ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static RENDERCORE_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FBinkDrawVS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FBinkDrawVS

code: struct FBinkDrawVS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


className: DefineName

code: static DefineName = TEXT( "ALPHA" );


className: FALPHA

code: class FALPHA : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: static DefineName = TEXT( "SRGB" );


className: FSRGB

code: class FSRGB : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static RENDERCORE_API [ShaderMetaType](API\Runtime\RenderCore\FBinkDrawYCbCrPS\ShaderMetaType) & GetStaticType()


code: RENDERCORE_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FBinkDrawYCbCrPS](API\Runtime\RenderCore\FBinkDrawYCbCrPS) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static bool ShouldCompilePermutation ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters )


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static RENDERCORE_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FBinkDrawYCbCrPS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FBinkDrawYCbCrPS

code: struct FBinkDrawYCbCrPS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


className: Alignment

code: static Alignment = 16;


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FBinkParameters](API\Runtime\RenderCore\FBinkParameters) & InContents, EUniformBufferUsage InUsage )


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FBinkParameters TAlignedType


className: zzFuncPtr

code: typedef void * zzFuncPtr


code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdcbc

code: typedef zzNextMemberIdcrc zzMemberIdcbc


className: zzMemberIdadj

code: typedef zzNextMemberIdcbc zzMemberIdadj


code: typedef zzFirstMemberId zzMemberIdtex0


className: FBinkParameters

code: class FBinkParameters

adj

type: TShaderParamete...

RenderTargets

type: FRenderTargetBi...

type: TShaderResource...


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: static RENDERCORE_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


code: RENDERCORE_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FBMPConvertPS](API\Runtime\RenderCore\FBMPConvertPS) >::Type InternalBaseType


code: template<int Counter> struct InternalLinkType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: void SetParameters ( [FRHIBatchedShaderParameters](API\Runtime\RHI\FRHIBatchedShaderParameters) & BatchedParameters, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< FRHITexture2D > BMPTexture, const FIntPoint & OutputDimensions, bool SrgbToLinear )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static RENDERCORE_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FBMPConvertPS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FBMPConvertPS

description: This shader expects a BMP frame packed into a single texture in PF_B8G8R8A8 format.

code: class FBMPConvertPS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: const char * GetAnsiName() const


description: Returns the global list of all dynamic resolution budgets.

code: static [TLinkedList](API\Runtime\Core\Containers\TLinkedList)< [FBudget](API\Runtime\RenderCore\FBudget) * > *& GetGlobalList()


code: static int32 GetGlobalListSize()


description: Returns the settings of the heuristic for this budget.

code: const [FHeuristicSettings](API\Runtime\RenderCore\FHeuristicSettings) & GetSettings() const


code: bool operator== ( const [FBudget](API\Runtime\RenderCore\FBudget) & Other ) const


code: FBudget ( const TCHAR * Name, [FHeuristicSettings](API\Runtime\RenderCore\FHeuristicSettings)(*)(void) HeuristicSettingsGetter )


code: FBudget &40; const FBudget & &41;


className: FBudget

description: Represent an independent budget to dynamically scale by its own.

code: class FBudget


code: [FBufferWithRDG](API\Runtime\RenderCore\FBufferWithRDG) & operator= ( const [FBufferWithRDG](API\Runtime\RenderCore\FBufferWithRDG) & Other )


description: Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void ReleaseRHI()


code: FBufferWithRDG ( const [FBufferWithRDG](API\Runtime\RenderCore\FBufferWithRDG) & Other )


className: FBufferWithRDG

code: class FBufferWithRDG : public [FRenderResource](API\Runtime\RenderCore\FRenderResource)

Buffer

type: TRefCountPtr<F...


className: FClearQuadCallbacks

code: struct FClearQuadCallbacks

PostClear

type: TFunction< void...


className: FCachedUniformBufferDeclaration

code: struct FCachedUniformBufferDeclaration

Declaration

type: FThreadSafeShar...

description: Using SharedPtr so we can hand off lifetime ownership toFShaderCompilerEnvironment::IncludeVirtualPathToExternalContentsMapwhen invalidating this cache.


description: Initialize the RHI for this rendering resource

code: virtual void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


className: FClearVertexBuffer

code: class FClearVertexBuffer : public [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer)


code: void AppendString ( FStringBuilderBase & Out ) const


code: void AppendString ( FAnsiStringBuilderBase & Out ) const


code: bool operator== ( const [FCompactFullName](API\Runtime\RenderCore\FCompactFullName) & Other ) const


code: void ParseFromString ( const FStringView & Src )


description: Used to set up some compactFNamepaths for theFCompactFullName

code: void SetCompactFullNameFromObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InDepObject )


className: FCompactFullName

code: struct FCompactFullName

ObjectClassAndPath

type: TArray<FName, ...


description: FORCEINLINE

code: bool operator() ( const [FShaderPipelineType](API\Runtime\RenderCore\FShaderPipelineType) & A, const [FShaderPipelineType](API\Runtime\RenderCore\FShaderPipelineType) & B ) const


className: FCompareShaderPipelineNameTypes

description: Used to compare two shader pipeline types by name.

code: class FCompareShaderPipelineNameTypes


code: bool operator() ( const [FShaderType](API\Runtime\RenderCore\FShaderType) & A, const [FShaderType](API\Runtime\RenderCore\FShaderType) & B ) const


className: FCompareShaderTypes

description: Used to compare two shader types by name.

code: class FCompareShaderTypes


code: bool operator() ( const [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) & A, const [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) & B ) const


className: FCompareVertexFactoryTypes

description: Used to compare two Vertex Factory types by name.

code: class FCompareVertexFactoryTypes


className: ExpBits

code: static constexpr uint32 ExpBits = 8;


className: ExpBias

code: static constexpr uint32 ExpBias = ( 1 << (ExpBits - 1) ) - 1;


className: MantissaBits

code: static constexpr uint32 MantissaBits = SignMantissaBits - 1;


className: SignMantissaBits

code: static constexpr uint32 SignMantissaBits = 16;


className: SignMantissaMask

code: static constexpr uint32 SignMantissaMask = (1 << SignMantissaBits) - 1;


code: FCompressedTransform ( const [FRenderTransform](API\Runtime\RenderCore\FRenderTransform) & In )


className: FCompressedTransform

code: struct FCompressedTransform


description: Create and set up an 1D indirect dispatch argument from some GPU-side integer in a buffer (InputCountBuffer). Sets up a group count as (InputCountBuffer[InputCountOffset] * Multiplier + Divisor - 1U) / Divisor; Commonly use Divisor <=> number of threads per group.

code: namespace FComputeShaderUtils { FRDGBufferRef FComputeShaderUtils::AddIndirectArgsSetupCsPass1D ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, FRDGBufferRef & InputCountBuffer, const TCHAR * OutputBufferName, uint32 Divisor, uint32 InputCountOffset, uint32 Multiplier ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, const TShaderRef< TShaderClass > & ComputeShader, typename TShaderClass::FParameters * Parameters, FIntVector GroupCount ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, const TShaderRef< TShaderClass > & ComputeShader, typename TShaderClass::FParameters * Parameters, FRDGDispatchGroupCountCallback && GroupCountCallback ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, ERDGPassFlags PassFlags, const TShaderRef< TShaderClass > & ComputeShader, typename TShaderClass::FParameters * Parameters, FIntVector GroupCount ) }


description: Dispatch a compute shader to render graph builder with its parameters.

code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, ERDGPassFlags PassFlags, const TShaderRef< TShaderClass > & ComputeShader, const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * ParametersMetadata, typename TShaderClass::FParameters * Parameters, FIntVector GroupCount ) }


description: Dispatch a compute shader to render graph builder with its parameters. GroupCount is supplied through a callback. This allows adding a dispatch with unknown GroupCount but the value must be ready before the pass is executed.

code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, ERDGPassFlags PassFlags, const TShaderRef< TShaderClass > & ComputeShader, const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * ParametersMetadata, typename TShaderClass::FParameters * Parameters, FRDGDispatchGroupCountCallback && GroupCountCallback ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, const TShaderRef< TShaderClass > & ComputeShader, typename TShaderClass::FParameters * Parameters, FRDGBufferRef IndirectArgsBuffer, uint32 IndirectArgsOffset, FRDGDispatchLateParamCallback && DispatchLateParamCallback ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> FRDGPassRef FComputeShaderUtils::AddPass ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRDGEventName](API\Runtime\RenderCore\FRDGEventName) && PassName, ERDGPassFlags PassFlags, const TShaderRef< TShaderClass > & ComputeShader, typename TShaderClass::FParameters * Parameters, FRDGBufferRef IndirectArgsBuffer, uint32 IndirectArgsOffset, FRDGDispatchLateParamCallback && DispatchLateParamCallback ) }


code: namespace FComputeShaderUtils { void FComputeShaderUtils::ClearUAV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, FRDGBufferUAVRef UAV, uint32 ClearValue ) }


code: namespace FComputeShaderUtils { void FComputeShaderUtils::ClearUAV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FGlobalShaderMap](API\Runtime\RenderCore\FGlobalShaderMap) * ShaderMap, FRDGBufferUAVRef UAV, FVector4f ClearValue ) }


code: namespace FComputeShaderUtils { template<typename TShaderClass> void FComputeShaderUtils::Dispatch ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & RHICmdList, const TShaderRef< TShaderClass > & ComputeShader, const typename TShaderClass::FParameters & Parameters, FIntVector GroupCount ) }


description: Dispatch a compute shader to rhi command list with its parameters.

code: namespace FComputeShaderUtils { template<typename TShaderClass> void FComputeShaderUtils::Dispatch ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & RHICmdList, const TShaderRef< TShaderClass > & ComputeShader, const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * ParametersMetadata, const typename TShaderClass::FParameters & Parameters, FIntVector GroupCount ) }


description: Indirect dispatch a compute shader to rhi command list with its parameters.

code: namespace FComputeShaderUtils { template<typename TShaderClass> void FComputeShaderUtils::DispatchIndirect ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & RHICmdList, const TShaderRef< TShaderClass > & ComputeShader, const typename TShaderClass::FParameters & Parameters, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * IndirectArgsBuffer, uint32 IndirectArgOffset ) }


description: Dispatch a compute shader to rhi command list with its parameters and indirect args.

code: namespace FComputeShaderUtils { template<typename TShaderClass> void FComputeShaderUtils::DispatchIndirect ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & RHICmdList, const TShaderRef< TShaderClass > & ComputeShader, const typename TShaderClass::FParameters & Parameters, FRDGBufferRef IndirectArgsBuffer, uint32 IndirectArgOffset ) }


description: Compute the number of groups to dispatch.

code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCount ( const int32 ThreadCount, const int32 GroupSize ) }


code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCount ( const FIntPoint & ThreadCount, const FIntPoint & GroupSize ) }


code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCount ( const FIntPoint & ThreadCount, const int32 GroupSize ) }


code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCount ( const FIntVector & ThreadCount, const FIntVector & GroupSize ) }


code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCount ( const FIntVector & ThreadCount, const int32 GroupSize ) }


description: Wrapping number of groups to Y and Z dimension if X group count overflows GRHIMaxDispatchThreadGroupsPerDimension. Calculate the linear group index as (or use GetUnWrappedDispatchGroupId(GroupId) in ComputeShaderUtils.ush): uint LinearGroupId = GroupId.X + (GroupId.Z * WrappedGroupStride + GroupId.Y) * WrappedGroupStride; Note that you must use an early out because LinearGroupId may be larger than the ideal due to wrapping.

code: namespace FComputeShaderUtils { FIntVector FComputeShaderUtils::GetGroupCountWrapped ( const int32 TargetGroupCount ) }