description: Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMotionDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FMotionEvent](API\Runtime\SlateCore\Input\FMotionEvent) & InMotionEvent )


description:
Called when a mouse button is double clicked. Override this in derived classes.
Returns whether the event was handled, along with other possible actions

module: UMG

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description:
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Called when this widget had captured the mouse, but that capture has been revoked for some reason.

code: virtual void OnMouseCaptureLost ( const [FCaptureLostEvent](API\Runtime\SlateCore\Input\FCaptureLostEvent) & CaptureLostEvent )


description: The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

code: virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

code: virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

code: virtual [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) OnNavigation ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FNavigationEvent](API\Runtime\SlateCore\Input\FNavigationEvent) & InNavigationEvent )


description:
Called when the mouse wheel is spun. This event is bubbled.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
The maximum layer ID attained by this widget or any of its children.

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


description: Use this event sparingly as preview events generally make UIs more difficult to reason about.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnPreviewMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
This event is primarily to allow parent widgets to consume an event before a child widget processes it and it should be used only when there is no better design alternative.
Returns whether the event was handled, along with other possible actions

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


description: Called when a touchpad touch is ended (finger lifted)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Called when a touchpad touch force changes

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchForceChanged ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & TouchEvent )


description:
TOUCH and GESTURES Called when the user performs a gesture on trackpad. This event is bubbled.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchGesture ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & GestureEvent )


description: Called when a touchpad touch is started (finger down)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Called when a touchpad touch is moved (finger moved)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchMoved ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


code: void SetPadding ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: SWidgetTick override. Note this will not be called if bCanTick is set to false by the UserWidget

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


className: SObjectWidget

description: TheSObjectWidgetallows UMG to insert anSWidgetinto the hierarchy that manages the lifetime of the UMGUWidgetthat created it. Once theSObjectWidgetis destroyed it frees the reference it holds to TheUWidgetallowing it to be garbage collected. It also forwards the slate events to theUUserWidgetso that it can forward them to listeners.

code: class SObjectWidget : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)

WidgetObject

type: TObjectPtr<UUs...

description: TheUWidgetthat created thisSObjectWidgetwho needs to be kept alive.


code: virtual const [FSlateInvalidationRoot](API\Runtime\SlateCore\FastUpdate\FSlateInvalidationRoot) * Advanced_AsInvalidationRoot() const


code: virtual bool Advanced_IsInvalidationRoot() const


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


code: virtual bool CustomPrepass ( float LayoutScaleMultiplier )


description: Constructor

code: void Construct ( const [FArguments](API\Runtime\UMG\Slate\SRetainerWidget\FArguments) & Args )


description: Returns all Widgets, including widget hidden from the invalidation system. This is used by the WidgetReflector.

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * Debug_GetChildrenForReflector()


className: EPaintRetainedContentResult

code: enum EPaintRetainedContentResult { NotPainted, Painted, Queued, TextureSizeTooBig, TextureSizeZero, }


code: NamedSlotProperty< FArguments > Content&40;&41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


code: WidgetArgsType & Phase &40; int32 InArg &41;


code: WidgetArgsType & PhaseCount &40; int32 InArg &41;


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


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


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


code: WidgetArgsType & StatId &40; FName InArg &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description: Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


className: FArguments

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


code: [UMaterialInstanceDynamic](API\Runtime\Engine\Materials\UMaterialInstanceDynamic) * GetEffectMaterial() const


description: the children root widget of the Invalidation root.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetRootWidget()


code: bool IsAnythingVisibleToRender() const


description: SCompoundWidgetinterface

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: [EPaintRetainedContentResult](API\Runtime\UMG\Slate\SRetainerWidget\EPaintRetainedContentResult) PaintRetainedContentImpl ( const [FSlateInvalidationContext](API\Runtime\SlateCore\FastUpdate\FSlateInvalidationContext) & Context, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, int32 LayerId )


code: virtual int32 PaintSlowPath ( const [FSlateInvalidationContext](API\Runtime\SlateCore\FastUpdate\FSlateInvalidationContext) & Context )


description: Requests that the retainer redraw the hosted content next time it's painted.

code: void RequestRender()


code: void SetContent ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent )


code: void SetIsDesignTime ( bool bInIsDesignTime )


code: void SetEffectMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * EffectMaterial )


code: void SetRetainedRendering ( bool bRetainRendering )


code: void SetRenderingPhase ( int32 Phase, int32 PhaseCount )


code: void SetShowEffectsInDesigner ( bool bInShowEffectsInDesigner )


code: void SetTextureParameter ( [FName](API\Runtime\Core\UObject\FName) TextureParameter )


code: void SetWorld ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: static [TFrameValue](API\Runtime\Core\Misc\TFrameValue)< int32 > Shared_RetainerWorkThisFrame;


code: static [TArray](API\Runtime\Core\Containers\TArray)< [SRetainerWidget](API\Runtime\UMG\Slate\SRetainerWidget) *, TInlineAllocator< 3 > > Shared_WaitingToRender;


code: bool ShouldBeRenderingOffscreen() const


className: SRetainerWidget

description: TheSRetainerWidgetrenders children widgets to a render target first before later rendering that render target to the screen. This allows both frequency and phase to be controlled so that the UI can actually render less often than the frequency of the main game render. It also has the side benefit of allow materials to be applied to the render target after drawing the widgets to apply a simple post process.

code: class SRetainerWidget : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget), public [FSlateInvalidationRoot](API\Runtime\SlateCore\FastUpdate\FSlateInvalidationRoot)


code: void AddComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > Widget )


code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


code: void Construct ( const [FArguments](API\Runtime\UMG\Slate\SWorldWidgetScreenLayer\FArguments) & InArgs, const [FLocalPlayerContext](API\Runtime\Engine\Engine\FLocalPlayerContext) & InPlayerContext )


code: typedef FArguments WidgetArgsType


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


code: void RemoveComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component )


code: void SetWidgetPivot ( FVector2D Pivot )


code: void SetWidgetDrawSize ( FVector2D DrawSize )


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

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


className: SWorldWidgetScreenLayer

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


description: Convert the material into an MID and get a pointer to the MID so that parameters can be set on it.


description: Convert the static mesh data into slate vector art on demand. Does nothing in a cooked build.

code: void EnsureValidData()


description: Access the indexes for the order in which to draw the vertexes.

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


description: Material to be used with the specified vector art data.

code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetMaterial() const


description: Access the slate vertexes.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSlateMeshVertex](API\Runtime\UMG\Slate\FSlateMeshVertex) > & GetVertexData() const


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


className: USlateVectorArtData

description: Turn static mesh data into Slate's simple vector art format.

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


module: VectorVM

code: void Init ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 const *__restrict const > & InInputRegisters, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 const *__restrict const > & InOutputRegisters, int32 InInstanceOffset, [TArray](API\Runtime\Core\Containers\TArray)< int32 > * InIDTable, [TArray](API\Runtime\Core\Containers\TArray)< int32 > * InFreeIDTable, int32 * InNumFreeIDs, int32 * InNumSpawnedIDs, int32 * InMaxUsedID, int32 InIDAcquireTag, [TArray](API\Runtime\Core\Containers\TArray)< int32 > * InSpawnedIDsTable )


description: Temporary lock we're using for thread safety when writing to the FreeIDTable. TODO: A lock free algorithm is possible here. We can create a specialized lock free list and reuse the IDTable slots for FreeIndices as Next pointers for our LFL. This would also work well on the GPU. UE-65856 for tracking this work.

code: FDataSetMeta()


description: Non-copyable and non-movable.

code: FDataSetMeta &40; FDataSetMeta && &41;


code: FDataSetMeta &40; const FDataSetMeta & &41;


className: FDataSetMeta

description: TODO: All of this stuff can be handled by the VM compiler rather than dirtying the VM code. Some require RWBuffer like support.

code: struct FDataSetMeta

FreeIDTable

type: TArray< int32 >...

InputRegisters

type: TArrayView< uin...

MaxUsedID

type: int32 *

description: MaxID used in this execution.

NumFreeIDs

description: Number of free IDs in the FreeIDTable


className: FExternalFuncConstHandler

code: template<typename T> struct FExternalFuncConstHandler

Constant

type: T


code: void Init ( FVectorVMExternalFunctionContext & Context )


code: FExternalFuncInputHandler ( FVectorVMExternalFunctionContext & Context )


className: FExternalFuncInputHandler

description: A flexible handler that can deal with either constant or register inputs.

code: template<typename T> struct FExternalFuncInputHandler


className: FExternalFuncRegisterHandler

code: template<typename T> struct FExternalFuncRegisterHandler


code: FUserPtrHandler ( FVectorVMExternalFunctionContext & Context )


className: FUserPtrHandler::operator const T *

code: operator const T *() const


className: FUserPtrHandler::operator T *

code: operator T *()


className: FUserPtrHandler

code: template<typename T> struct FUserPtrHandler

Ptr

type: T *


className: FVectorVMExecArgs

code: struct FVectorVMExecArgs

bAllowParallel

type: bool

ByteCode

type: uint8 const ...

ConstantTable

type: const uint8 ...

ConstantTableSizes

type: const int32 ...

DataSetMetaTable

type: TArrayView<FDa...

ExternalFunctionTable

type: const FVMExtern...

UserPtrTable

type: void **


className: FVectorVMSerializeState

code: struct FVectorVMSerializeState

FreeFn

type: VectorVMFreeFn ...

ReallocFn

type: VectorVMRealloc...


code: namespace VectorVM { uint8 VectorVM::CreateSrcOperandMask ( EVectorVMOperandLocation Type0, EVectorVMOperandLocation Type1, EVectorVMOperandLocation Type2 ) }


description: Get total number of op-codes

code: namespace VectorVM { uint8 VectorVM::GetNumOpCodes() }


className: FVectorVMState

code: struct FVectorVMState


code: namespace VectorVM { [FString](API\Runtime\Core\Containers\FString) VectorVM::GetOperandLocationName ( EVectorVMOperandLocation Location ) }


description: Dummy methods binding pointers to external methods to avoid them from being stripped by compiler

code: namespace VectorVM { void VectorVM::Init() }


code: namespace VectorVM { [FString](API\Runtime\Core\Containers\FString) VectorVM::GetOpName ( EVectorVMOp Op ) }


className: FVirtualFileCacheSettings

module: VirtualFileCache

code: struct FVirtualFileCacheSettings

OverrideDefaultDirectory

type: FString

RecentWriteLRUSize

description: Memory Cache behavior.


code: double CurrentFragmentation() const


code: void EraseData ( VFCKey Id )


code: bool DoesChunkExist ( const VFCKey & Id ) const


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< uint64 > GetSizeForChunk ( const VFCKey & Id ) const


code: uint64 GetTotalMemCacheHits() const


code: uint64 GetTotalMemCacheMisses() const


code: int64 GetTotalSize() const


code: int64 GetUsedSize() const


code: void Initialize ( const [FVirtualFileCacheSettings](API\Runtime\VirtualFileCache\FVirtualFileCacheSettings) & Context )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IVirtualFileCache](API\Runtime\VirtualFileCache\IVirtualFileCache), ESPMode::ThreadSafe > CreateVirtualFileCache()


code: [TFuture](API\Runtime\Core\Async\TFuture)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 > > ReadData ( VFCKey Id, int64 ReadOffset, int64 ReadSizeOrZero )


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) WriteData ( VFCKey Id, const uint8 * Data, uint64 DataSize )


code: virtual ~IVirtualFileCache()


className: IVirtualFileCache

code: struct IVirtualFileCache


description:
Instantiates a new voice capture object
new voice capture object, possibly NULL

module: Voice

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVoiceCapture](API\Runtime\Voice\Interfaces\IVoiceCapture) > CreateVoiceCapture ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, int32 SampleRate, int32 NumChannels )


description:
Instantiates a new voice decoder object
new voice decoder object, possibly NULL

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVoiceDecoder](API\Runtime\Voice\Interfaces\IVoiceDecoder) > CreateVoiceDecoder ( int32 SampleRate, int32 NumChannels )


description:
Instantiates a new voice encoder object
new voice encoder object, possibly NULL

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVoiceEncoder](API\Runtime\Voice\Interfaces\IVoiceEncoder) > CreateVoiceEncoder ( int32 SampleRate, int32 NumChannels, EAudioEncodeHint EncodeHint )


description:
Checks to see if the current platform supports voice capture.
True if the current platform support voice capture


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FVoiceModule](API\Runtime\Voice\FVoiceModule) & Get()


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

code: static bool IsAvailable()


description: true if voice is enabled

code: bool IsVoiceEnabled() const


description: Possible states related to voice capture

code: namespace EVoiceCaptureState { enum Type { UnInitialized, NotCapturing, Ok, NoData, Stopping, BufferTooSmall, Error, } }


className: FVoiceModule

description: Logging related to general voice chat flow (muting/registration/etc) Logging related to encoding of local voice packets Logging related to decoding of remote voice packets Internal voice capture logging Module for Voice capture/compression/decompression implementations

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


description: the stringified version of the enum passed in

code: namespace EVoiceCaptureState { const TCHAR * EVoiceCaptureState::ToString ( [EVoiceCaptureState::Type](API\Runtime\Voice\Interfaces\EVoiceCaptureState__Type) VoiceCaptureState ) }


description:
Change the associated capture device
true if change was successful, false otherwise

code: bool ChangeDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, int32 SampleRate, int32 NumChannels )


description: Dump the state of the voice capture device

code: void DumpState() const


description:
Return the state of the voice data and its availability
state of the voice capture buffer

code: [EVoiceCaptureState::Type](API\Runtime\Voice\Interfaces\EVoiceCaptureState__Type) GetCaptureState ( uint32 & OutAvailableVoiceData ) const


description: the current loudness of the microphone. Returns -1.0 if this function is not supported by the current platform.

code: virtual float GetCurrentAmplitude() const


description: number of bytes currently allocated in the capture buffer

code: int32 GetBufferSize() const


description: a new output for this mic's audio.

code: [Audio::FPatchOutputStrongPtr](API\Runtime\Engine\FPatchOutputStrongPtr) GetMicrophoneAudio ( int32 MaxExpectedLatencyInSamples, float Gain )


code: virtual [EVoiceCaptureState::Type](API\Runtime\Voice\Interfaces\EVoiceCaptureState__Type) GetVoiceData ( uint8 * OutVoiceBuffer, uint32 InVoiceBufferSize, uint32 & OutAvailableVoiceData, uint64 & OutSampleCounter )


description:
Fill a buffer with all available voice data
state of the voice capture buffer

code: virtual [EVoiceCaptureState::Type](API\Runtime\Voice\Interfaces\EVoiceCaptureState__Type) GetVoiceData ( uint8 * OutVoiceBuffer, uint32 InVoiceBufferSize, uint32 & OutAvailableVoiceData )


description:
Initialize the voice capture object
true if successful, false otherwise

code: bool Init ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName, int32 SampleRate, int32 NumChannels )


description:
Is the voice capture object actively capturing
true if voice is being captured, false otherwise

code: bool IsCapturing()


description: Shutdown the voice capture object

code: void Shutdown()


description:
Start capturing voice
true if successfully started, false otherwise

code: bool Start()


description: Stop capturing voice

code: void Stop()


description: Decode an encoded audio stream (outputs 16bit PCM audio)

code: void Decode ( const uint8 * CompressedData, uint32 CompressedDataSize, uint8 * OutRawPCMData, uint32 & OutRawDataSize )


className: IVoiceCapture

description: Interface for capturing voice data on any platform

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

MicrophoneOutput

description: Optional patch point for MicrophoneOutput.


description: Cleanup the decoder

code: void Destroy()


description: Output the state of the decoder


description:
Initialize the decoder
true if initialization was successful, false otherwise

code: bool Init ( int32 SampleRate, int32 NumChannels )


description: Reset the decoder back to its initial state

code: void Reset()


className: IVoiceDecoder

description: Interface for decoding voice passed over the wire

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


description: Cleanup the encoder


description:
Encode a raw audio stream (expects 16bit PCM audio)
number of bytes at the end of the stream that wasn't encoded (some interfaces can only encode at a certain frame slice)

code: int32 Encode ( const uint8 * RawPCMData, uint32 RawDataSize, uint8 * OutCompressedData, uint32 & OutCompressedDataSize )


description: Output the state of the encoder

code: void DumpState() const


description:
Initialize the encoder
true if initialization was successful, false otherwise

code: bool Init ( int32 SampleRate, int32 NumChannels, EAudioEncodeHint EncodeHint )


description: Reset the encoder back to its initial state


description:
Adjust the encoding complexity (platform specific)
true if successfully changed, false otherwise

code: bool SetComplexity ( int32 InComplexity )


description:
Set the encoding to variable bitrate
true if successfully changed, false otherwise

code: bool SetVBR ( bool bEnableVBR )


description:
Adjust the encoding bitrate
true if successfully changed, false otherwise

code: bool SetBitrate ( int32 InBitRate )


className: IVoiceEncoder

description: Interface for encoding raw voice for transmission over the wire

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


className: FVoronoiCellInfo

description: All the info you would typically want about a single cell in the Voronoi diagram, in the format that is easiest to compute.

module: Voronoi

code: struct FVoronoiCellInfo

Faces

type: TArray< int32 >

Normals

type: TArray< FVector...


code: [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & operator= ( const [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & Other )


code: [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & operator= ( [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) && Other )


code: FVoronoiComputeHelper ( const [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & Other )


code: FVoronoiComputeHelper ( [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) && Other )


className: FVoronoiComputeHelper

description: The Voronoi Compute Helper caches information to help compute cells quickly To safely parallelize voronoi diagram construction, create a separate compute helper per-thread

code: class FVoronoiComputeHelper


code: int32 ApproxSitesPerThreadWithDefault ( int32 ApproxSitesPerThreadIn )


code: void ComputeAllCells ( [TArray](API\Runtime\Core\Containers\TArray)< [FVoronoiCellInfo](API\Runtime\Voronoi\Voronoi\FVoronoiCellInfo) > & AllCells, int32 ApproxSitesPerThread )


code: void ComputeAllCellsSerial ( [TArray](API\Runtime\Core\Containers\TArray)< [FVoronoiCellInfo](API\Runtime\Voronoi\Voronoi\FVoronoiCellInfo) > & AllCells )


code: void ComputeAllNeighbors ( [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< int32 >> & AllNeighbors, bool bExcludeBounds, int32 ApproxSitesPerThread )


code: void ComputeCellEdgesSerial ( [TArray](API\Runtime\Core\Containers\TArray)< [TTuple](API\Runtime\Core\Misc\TTuple)< FVector, FVector >> & Edges, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & CellMember )


code: void ComputeCellEdges ( [TArray](API\Runtime\Core\Containers\TArray)< [TTuple](API\Runtime\Core\Misc\TTuple)< FVector, FVector >> & Edges, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & CellMember, int32 ApproxSitesPerThread )


code: void AddSites ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > & Sites, double SquaredDistSkipPtThreshold )


code: int32 FindCell ( const FVector & Pos, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper ) const


description:
Find the closest Voronoi cell to a given position
The id of the Voronoi cell containing the given position, or -1 if position is outside diagram

code: int32 FindCell ( const FVector & Pos, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper, FVector & OutFoundSite ) const


code: static FBox GetBounds ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > & Sites, double ExtraBoundingSpace )


description: Create a Voronoi diagram with the given sites, in a given bounding box. Any previous data is discarded.

code: void Initialize ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > & Sites, const FBox & Bounds, double ExtraBoundingSpace, double SquaredDistSkipPtThreshold )


className: MinDefaultSitesPerThread

code: static const int MinDefaultSitesPerThread = 150;


code: [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) & operator= ( const [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) & Other )


code: [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) & operator= ( [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) && Other )


description: Make an empty diagram, to be filled in with a subsequent call to "Initialize()"

code: FVoronoiDiagram()


code: FVoronoiDiagram ( [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) && Other )


code: FVoronoiDiagram ( const [FVoronoiDiagram](API\Runtime\Voronoi\Voronoi\FVoronoiDiagram) & Other )


description: Create a Voronoi diagram with the given sites, in a box bounding containing those sites

code: FVoronoiDiagram ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > & Sites, double ExtraBoundingSpace, double SquaredDistSkipPtThreshold )


description: Make a container for a Voronoi diagram without any points. CallAddSites()after to finish creating the diagram.

code: FVoronoiDiagram ( int32 ExpectedNumSites, const FBox & Bounds, double ExtraBoundingSpace )


description: Create a Voronoi diagram with the given sites, in a given bounding box

code: FVoronoiDiagram ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const FVector > & Sites, const FBox & Bounds, double ExtraBoundingSpace, double SquaredDistSkipPtThreshold )


className: FVoronoiDiagram

code: class FVoronoiDiagram


code: int32 ClosestID ( const FVector & Sample, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper )


code: TPair< int32, int32 > ClosestTwoIDs ( const FVector & Sample, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper )


description: Distance to the nearest Voronoi cell boundary (ignoring bounding box walls), or InvalidValue if outside of bounds

code: double DistanceToCellWall ( const FVector & Sample, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper, double InvalidValue )


description: Distance to the nearest Voronoi site, or InvalidValue if outside of bounds

code: double DistanceToClosest ( const FVector & Sample, [FVoronoiComputeHelper](API\Runtime\Voronoi\Voronoi\FVoronoiComputeHelper) & ComputeHelper, double InvalidValue )


code: void Initialize ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & SitesIn, const FBox & Bounds, double SquaredDistSkipPtThreshold )


code: [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) & operator= ( const [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) & Other )


code: [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) & operator= ( [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) && Other )


code: FVoronoiDiagramField ( const [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) & Other )


code: FVoronoiDiagramField ( [FVoronoiDiagramField](API\Runtime\Voronoi\Voronoi\FVoronoiDiagramField) && Other )


code: FVoronoiDiagramField ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & SitesIn, const FBox & Bounds, double SquaredDistSkipPtThreshold )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IVoronoiPlugin](API\Runtime\Voronoi\Voronoi\IVoronoiPlugin) & Get()


className: FVoronoiDiagramField

description: Note: Queries are only thread safe if each thread has its ownFVoronoiComputeHelper

code: class FVoronoiDiagramField


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

code: static bool IsAvailable()


className: IVoronoiPlugin

description: The public interface to this module

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


module: VulkanRHI

code: namespace EVulkanBindingType { static char EVulkanBindingType::GetBindingTypeChar ( [EType](API\Runtime\VulkanRHI\EVulkanBindingType__EType) Type ) }


code: namespace EVulkanBindingType { enum EType { PackedUniformBuffer, UniformBuffer, CombinedImageSampler, Sampler, Image, UniformTexelBuffer, StorageImage, StorageTexelBuffer, StorageBuffer, InputAttachment, AccelerationStructure, Count, } }


className: FOptionalVulkanInstanceExtensions

type: union FOptional...


code: FOptionalVulkanInstanceExtensions()


code: virtual FTexture2DRHIRef AsyncReallocateTexture2D_RenderThread ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * Texture2D, int32 NewMipCount, int32 NewSizeX, int32 NewSizeY, [FThreadSafeCounter](API\Runtime\Core\HAL\FThreadSafeCounter) * RequestStatus )


code: template<class ContainerType> class voro_compute


className: EActiveDebugLayerExtension

code: enum EActiveDebugLayerExtension { None, GfxReconstructLayer, VkTraceLayer, DebugUtilsExtension, DebugReportExtension, }


code: virtual ETextureReallocationStatus FinalizeAsyncReallocateTexture2D_RenderThread ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * Texture2D, bool bBlockUntilCompleted )


code: static [FVulkanDynamicRHI](API\Runtime\VulkanRHI\FVulkanDynamicRHI) & Get()


code: FVulkanDevice * GetDevice() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > & GetInstanceExtensions() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > & GetInstanceLayers() const


code: virtual const TCHAR * GetName()


code: const [FOptionalVulkanInstanceExtensions](API\Runtime\VulkanRHI\FOptionalVulkanInstanceExtension-) & GetOptionalExtensions() const


description: Initializes the RHI; separate fromIDynamicRHIModule::CreateRHIso that GDynamicRHI is set when it is called.

code: virtual void Init()


code: [TArray](API\Runtime\Core\Containers\TArray)< FVulkanViewport * > & GetViewports()


code: void InitDevice ( FVulkanDevice * Device )


code: void InitGPU ( FVulkanDevice * Device )


code: void InternalUnlockTexture2D ( bool bFromRenderingThread, FRHITexture2D * Texture, uint32 MipIndex, bool bLockWithinMiptail )


code: void InternalUpdateTexture2D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FRHITexture2D * TextureRHI, uint32 MipIndex, const struct [FUpdateTextureRegion2D](API\Runtime\RHI\FUpdateTextureRegion2D) & UpdateRegion, uint32 SourcePitch, const uint8 * SourceData )


code: void InternalUpdateTexture3D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FRHITexture3D * TextureRHI, uint32 MipIndex, const struct [FUpdateTextureRegion3D](API\Runtime\RHI\FUpdateTextureRegion3D) & UpdateRegion, uint32 SourceRowPitch, uint32 SourceDepthPitch, const uint8 * SourceData )


description: Buffer Lock/Unlock.

code: virtual void * LockBuffer_BottomOfPipe ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode )


code: virtual void * LockTexture2D_RenderThread ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * Texture, uint32 MipIndex, EResourceLockMode LockMode, uint32 & DestStride, bool bLockWithinMiptail, bool bNeedsDefaultRHIFlush, uint64 * OutLockedByteCount )


description: Called after the RHI is initialized; before the render thread is started.

code: virtual void PostInit()


code: static void RebuildPipelineCache()


code: static void RecreateSwapChain ( void * NewNativeWindow )


description: Acquires or releases ownership of the platform-specific rendering context for the calling thread


description: Only relevant with an RHI thread, this advances the backbuffer for the purpose of GetViewportBackBuffer FlushType: Thread safe

code: virtual void RHIAdvanceFrameForGetViewportBackBuffer ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport )


code: virtual void RHIAliasTextureResources ( FTextureRHIRef & DestTexture, FTextureRHIRef & SrcTexture )


description:
Thread-safe function that can be used to create a texture outside of the rendering thread. This function can ONLY be called if GRHISupportsAsyncTextureCreation is true. Cannot create rendertargets with this method.
a reference to a 2D texture resource

code: virtual FTextureRHIRef RHIAsyncCreateTexture2D ( uint32 SizeX, uint32 SizeY, uint8 Format, uint32 NumMips, ETextureCreateFlags Flags, ERHIAccess InResourceState, void ** InitialMipData, uint32 NumInitialMips, FGraphEventRef & OutCompletionEvent )


description: Returns a new reference to the texture, which will represent the new mip count when the reallocation is complete.RHIFinalizeAsyncReallocateTexture2D()must be called to complete the reallocation.

code: virtual FTexture2DRHIRef RHIAsyncReallocateTexture2D ( FRHITexture2D * Texture2D, int32 NewMipCount, int32 NewSizeX, int32 NewSizeY, [FThreadSafeCounter](API\Runtime\Core\HAL\FThreadSafeCounter) * RequestStatus )


code: virtual [FUpdateTexture3DData](API\Runtime\RHI\FUpdateTexture3DData) RHIBeginUpdateTexture3D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FRHITexture3D * Texture, uint32 MipIndex, const struct [FUpdateTextureRegion3D](API\Runtime\RHI\FUpdateTextureRegion3D) & UpdateRegion )


description: FlushType: Thread safe.

code: virtual void RHIBindDebugLabelName ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, const TCHAR * Name )


code: virtual void RHIBindDebugLabelName ( [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UnorderedAccessViewRHI, const TCHAR * Name )


description: Blocks the CPU until the GPU catches up and goes idle. FlushType: Flush Immediate (seems wrong)

code: virtual void RHIBlockUntilGPUIdle()


description: Computes the total GPU memory a texture resource with the specified parameters will occupy on the current RHI platform. Also returns the required alignment for the resource.

code: virtual [FRHICalcTextureSizeResult](API\Runtime\RHI\FDynamicRHI\FRHICalcTextureSizeResult) RHICalcTexturePlatformSize ( [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) const & Desc, uint32 FirstMipIndex )


code: virtual void RHICalibrateTimers()


description:
Cancels an async reallocation for the specified texture. This should be called for the new texture, not the original.
Reallocation status

code: virtual ETextureReallocationStatus RHICancelAsyncReallocateTexture2D ( FRHITexture2D * Texture2D, bool bBlockUntilCompleted )


description: Computes the size in memory required by a given texture.

code: virtual uint32 RHIComputeMemorySize ( [FRHITexture](API\Runtime\RHI\FRHITexture) * TextureRHI )


description: Copies the contents of one buffer to another buffer. They must have identical sizes.

code: virtual void RHICopyBuffer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SourceBuffer, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * DestBuffer )


code: virtual FTextureRHIRef RHICreateAliasedTexture ( FTextureRHIRef & SourceTexture )


description: Compute the hash of the PSO initializer for PSO Precaching (only hash data relevant for the RHI specific PSO)

code: virtual uint64 RHIComputePrecachePSOHash ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & Initializer )


description: Creates a bound shader state instance which encapsulates a decl, vertex shader and pixel shader CAUTION: Even though this is marked as threadsafe, it is only valid to call from the render thread or the RHI thread. It need not be threadsafe unless the RHI support parallel translation. CAUTION: Platforms that support RHIThread but don't actually have a threadsafe implementation must flush internally withFScopedRHIThreadStallerStallRHIThread(FRHICommandListExecutor::GetImmediateCommandList()); when the call is from the render thread

code: virtual FBoundShaderStateRHIRef RHICreateBoundShaderState ( [FRHIVertexDeclaration](API\Runtime\RHI\FRHIVertexDeclaration) * VertexDeclaration, [FRHIVertexShader](API\Runtime\RHI\FRHIVertexShader) * VertexShader, [FRHIPixelShader](API\Runtime\RHI\FRHIPixelShader) * PixelShader, [FRHIGeometryShader](API\Runtime\RHI\FRHIGeometryShader) * GeometryShader )


description: FlushType: Thread safe.

code: virtual FBlendStateRHIRef RHICreateBlendState ( const [FBlendStateInitializerRHI](API\Runtime\RHI\FBlendStateInitializerRHI) & Initializer )


description: FlushType: Thread safe.

code: virtual FComputePipelineStateRHIRef RHICreateComputePipelineState ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader )


code: virtual FBufferRHIRef RHICreateBuffer ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIBufferDesc](API\Runtime\RHI\FRHIBufferDesc) const & Desc, ERHIAccess ResourceState, [FRHIResourceCreateInfo](API\Runtime\RHI\FRHIResourceCreateInfo) & CreateInfo )


description: FlushType: Wait RHI Thread.

code: virtual FComputeShaderRHIRef RHICreateComputeShader ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Code, const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


description: FlushType: Thread safe.

code: virtual FDepthStencilStateRHIRef RHICreateDepthStencilState ( const [FDepthStencilStateInitializerRHI](API\Runtime\RHI\FDepthStencilStateInitializerRHI) & Initializer )


description: FlushType: Wait RHI Thread.

code: virtual FGeometryShaderRHIRef RHICreateGeometryShader ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Code, const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


code: virtual FGPUFenceRHIRef RHICreateGPUFence ( const [FName](API\Runtime\Core\UObject\FName) & Name )


description: FlushType: Wait RHI Thread.

code: virtual FPixelShaderRHIRef RHICreatePixelShader ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Code, const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


description: FlushType: Thread safe.

code: virtual FRasterizerStateRHIRef RHICreateRasterizerState ( const [FRasterizerStateInitializerRHI](API\Runtime\RHI\FRasterizerStateInitializerRHI) & Initializer )


description:
Creates a graphics pipeline state object (PSO) that represents a complete gpu pipeline for rendering. This function should be considered expensive to call at runtime and may cause hitches as pipelines are compiled.
FGraphicsPipelineStateRHIRef that can be bound for rendering; nullptr if the compilation fails. CAUTION: On certain RHI implementations (eg, ones that do not support runtime compilation) a compilation failure is a Fatal error and this function will not return. CAUTION: Even though this is marked as threadsafe, it is only valid to call from the render thread or the RHI thread. It need not be threadsafe unless the RHI support parallel translation. CAUTION: Platforms that support RHIThread but don't actually have a threadsafe implementation must flush internally withFScopedRHIThreadStallerStallRHIThread(FRHICommandListExecutor::GetImmediateCommandList()); when the call is from the render thread

code: virtual FGraphicsPipelineStateRHIRef RHICreateGraphicsPipelineState ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & Initializer )


description: FlushType: Wait RHI Thread.

code: virtual FRenderQueryRHIRef RHICreateRenderQuery ( ERenderQueryType QueryType )


description: FlushType: Thread safe.

code: virtual FSamplerStateRHIRef RHICreateSamplerState ( const [FSamplerStateInitializerRHI](API\Runtime\RHI\FSamplerStateInitializerRHI) & Initializer )


description:
Creates a staging buffer, which is memory visible to the cpu without any locking.
The new staging-buffer.


description: SRV / UAV creation functions.

code: virtual FShaderResourceViewRHIRef RHICreateShaderResourceView ( class [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * Resource, [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & ViewDesc )


description: Creates an RHI texture resource.

code: virtual FTextureRHIRef RHICreateTexture ( const [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & CreateDesc )


code: virtual FTexture2DRHIRef RHICreateTexture2DFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 NumMips, uint32 NumSamples, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: virtual FTextureCubeRHIRef RHICreateTextureCubeFromResource ( EPixelFormat Format, uint32 Size, bool bArray, uint32 ArraySize, uint32 NumMips, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: virtual FTexture2DArrayRHIRef RHICreateTexture2DArrayFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 ArraySize, uint32 NumMips, uint32 NumSamples, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: virtual FTextureRHIRef RHICreateTexture_RenderThread ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, const [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & CreateDesc )


description: Transient Resource Functions and Helpers.


code: virtual void RHICreateTransition ( [FRHITransition](API\Runtime\RHI\FRHITransition) * Transition, const [FRHITransitionCreateInfo](API\Runtime\RHI\FRHITransitionCreateInfo) & CreateInfo )


description:
Creates a uniform buffer. The contents of the uniform buffer are provided in a parameter, and are immutable. CAUTION: Even though this is marked as threadsafe, it is only valid to call from the render thread or the RHI thread. Thus is need not be threadsafe on platforms that do not support or aren't using an RHIThread
The new uniform buffer.

code: virtual FUniformBufferRHIRef RHICreateUniformBuffer ( const void * Contents, const [FRHIUniformBufferLayout](API\Runtime\RHI\FRHIUniformBufferLayout) * Layout, EUniformBufferUsage Usage, EUniformBufferValidation Validation )


code: virtual FUnorderedAccessViewRHIRef RHICreateUnorderedAccessView ( class [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * Resource, [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & ViewDesc )


description: FlushType: Wait RHI Thread.

code: virtual FVertexDeclarationRHIRef RHICreateVertexDeclaration ( const FVertexDeclarationElementList & Elements )


description: FlushType: Wait RHI Thread.

code: virtual FVertexShaderRHIRef RHICreateVertexShader ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > Code, const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


code: virtual bool RHIDoesAdapterMatchDevice ( const void * InAdapterId ) const


description: Must be called from the main thread. FlushType: Thread safe

code: virtual FViewportRHIRef RHICreateViewport ( void * WindowHandle, uint32 SizeX, uint32 SizeY, bool bIsFullscreen, EPixelFormat PreferredPixelFormat )


code: virtual void RHIEndUpdateTexture3D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FUpdateTexture3DData](API\Runtime\RHI\FUpdateTexture3DData) & UpdateData )


description: Deprecated* Altering image layout tracking directly is not permitted anymore.

code: virtual VkImageLayout & RHIFindOrAddLayoutRW ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, VkImageLayout LayoutIfNotFound )


description: Finalizes an async reallocation request. If bBlockUntilCompleted is false, it will only poll the status and finalize if the reallocation has completed.

code: virtual ETextureReallocationStatus RHIFinalizeAsyncReallocateTexture2D ( FRHITexture2D * Texture2D, bool bBlockUntilCompleted )


description: Called by parallel worker threads, and the RHI thread. Platform implementations must be thread safe.

code: virtual [IRHIPlatformCommandList](API\Runtime\RHI\IRHIPlatformCommandList) * RHIFinalizeContext ( [IRHIComputeContext](API\Runtime\RHI\IRHIComputeContext) * Context )


code: virtual void RHIFinishExternalComputeWork ( VkCommandBuffer InCommandBuffer )


description: Flush driver resources. Typically called when switching contexts/threads FlushType: Flush RHI Thread

code: virtual void RHIFlushResources()


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< VkExtensionProperties > RHIGetAllDeviceExtensions ( VkPhysicalDevice InPhysicalDevice ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< VkExtensionProperties > RHIGetAllInstanceExtensions() const


description:
Retrieve available screen resolutions.
bool true if successfully filled the array

code: virtual bool RHIGetAvailableResolutions ( FScreenResolutionArray & Resolutions, bool bIgnoreRefreshRate )


description: Called by parallel worker threads, and the render thread. Platform implementations must be thread safe.

code: virtual [IRHIComputeContext](API\Runtime\RHI\IRHIComputeContext) * RHIGetCommandContext ( ERHIPipeline Pipeline, [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) GPUMask )


code: virtual [FVulkanRHIAllocationInfo](API\Runtime\VulkanRHI\FVulkanRHIAllocationInfo) RHIGetAllocationInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


description: FlushType: Thread safe.

code: virtual [IRHIComputeContext](API\Runtime\RHI\IRHIComputeContext) * RHIGetDefaultAsyncComputeContext()


code: virtual uint64 RHIGetGraphicsAdapterLUID ( VkPhysicalDevice InPhysicalDevice ) const


description: FlushType: Thread safe.

code: virtual [IRHICommandContext](API\Runtime\RHI\IRHICommandContext) * RHIGetDefaultContext()


description: Returns the total GPU time taken to render the last frame. Same metric asFPlatformTime::Cycles().

code: virtual uint32 RHIGetGPUFrameCycles ( uint32 GPUIndex )


code: virtual uint32 RHIGetGraphicsQueueFamilyIndex() const


code: virtual uint32 RHIGetGraphicsQueueIndex() const


code: virtual VkQueue RHIGetGraphicsVkQueue() const


code: virtual [FVulkanRHIImageViewInfo](API\Runtime\VulkanRHI\FVulkanRHIImageViewInfo) RHIGetImageViewInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


description: Gets the minimum alignment (in bytes) required for creating a shader resource view on a buffer-backed resource.

code: virtual uint64 RHIGetMinimumAlignmentForBufferBackedSRV ( EPixelFormat Format )


description: Provides access to the native compute command queue. Generally this should be avoided but is useful for third party plugins.

code: virtual void * RHIGetNativeComputeQueue()


description: Provides access to the native device. Generally this should be avoided but is useful for third party plugins.

code: virtual void * RHIGetNativeDevice()


description: Provides access to the native graphics command queue. Generally this should be avoided but is useful for third party plugins.

code: virtual void * RHIGetNativeGraphicsQueue()


description: Provides access to the native instance. Generally this should be avoided but is useful for third party plugins.

code: virtual void * RHIGetNativeInstance()


description: CAUTION: Even though this is marked as threadsafe, it is only valid to call from the render thread. It is need not be threadsafe on platforms that do not support or aren't using an RHIThread FlushType: Thread safe, but varies by RHI

code: virtual bool RHIGetRenderQueryResult ( [FRHIRenderQuery](API\Runtime\RHI\FRHIRenderQuery) * RenderQuery, uint64 & OutResult, bool bWait, uint32 GPUIndex )


description: Returns a supported screen resolution that most closely matches input.

code: virtual void RHIGetSupportedResolution ( uint32 & Width, uint32 & Height )


code: virtual VkFormat RHIGetSwapChainVkFormat ( EPixelFormat InFormat ) const


description: Retrieves texture memory stats. safe to call on the main thread

code: virtual void RHIGetTextureMemoryStats ( [FTextureMemoryStats](API\Runtime\RHI\FTextureMemoryStats) & OutStats )


description:
Fills a texture with to visualize the texture pool memory.
true if successful, false otherwise

code: virtual bool RHIGetTextureMemoryVisualizeData ( [FColor](API\Runtime\Core\Math\FColor) * TextureData, int32 SizeX, int32 SizeY, int32 Pitch, int32 PixelSize )


description: With RHI thread, this is the current backbuffer from the perspective of the render thread. FlushType: Thread safe

code: virtual FTexture2DRHIRef RHIGetViewportBackBuffer ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport )


code: virtual VkFormat RHIGetViewVkFormat ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: virtual VkDevice RHIGetVkDevice() const


code: virtual const VkAllocationCallbacks * RHIGetVkAllocationCallbacks()


code: virtual void * RHIGetNativePhysicalDevice()


code: virtual void * RHIGetVkDeviceProcAddr ( const char * InName ) const


code: virtual VkImage RHIGetVkImage ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: virtual VkPhysicalDevice RHIGetVkPhysicalDevice() const


code: virtual VkInstance RHIGetVkInstance() const


code: virtual uint32 RHIGetVulkanVersion() const


code: virtual const uint8 * RHIGetVulkanDeviceUUID() const


description:
Locks an RHI texture's mip-map for read/write operations on the CPU
pointer to the CPU accessible resource data

code: virtual void * RHILockTexture2D ( FRHITexture2D * Texture, uint32 MipIndex, EResourceLockMode LockMode, uint32 & DestStride, bool bLockWithinMiptail, uint64 * OutLockedByteCount )


description: FlushType: Flush Immediate.

code: virtual bool RHIIsRenderingSuspended()


description:
Lock a staging buffer to read contents on the CPU that were written by the GPU, without having to stall.  This function requires that you have issued an CopyToStagingBuffer invocation and verified that theFRHIGPUFencehas been signaled before calling.
A pointer to the data starting at 'Offset' and of length 'SizeRHI' from 'StagingBuffer', or nullptr when there is an error.

code: virtual void * RHILockStagingBuffer ( [FRHIStagingBuffer](API\Runtime\RHI\FRHIStagingBuffer) * StagingBuffer, [FRHIGPUFence](API\Runtime\RHI\FRHIGPUFence) * Fence, uint32 Offset, uint32 SizeRHI )


code: virtual void * RHILockTexture2DArray ( FRHITexture2DArray * Texture, uint32 TextureIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32 & DestStride, bool bLockWithinMiptail )


description: Watch out for OutData to be 0 (can happen on DXGI_ERROR_DEVICE_REMOVED), don't call RHIUnmapStagingSurface in that case.

code: virtual void RHIMapStagingSurface ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, [FRHIGPUFence](API\Runtime\RHI\FRHIGPUFence) * Fence, void *& OutData, int32 & OutWidth, int32 & OutHeight, uint32 GPUIndex )


code: virtual void * RHILockTextureCubeFace ( FRHITextureCube * Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, EResourceLockMode LockMode, uint32 & DestStride, bool bLockWithinMiptail )


description: FlushType: Flush Immediate (seems wrong)

code: virtual void RHIRead3DSurfaceFloatData ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, FIntRect Rect, FIntPoint ZMinMax, [TArray](API\Runtime\Core\Containers\TArray)< [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) > & OutData )


description: Default fallback; will not work for non-8-bit surfaces and it's extremely slow.

code: virtual void RHIReadSurfaceData ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, FIntRect Rect, [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & OutData, [FReadSurfaceDataFlags](API\Runtime\RHI\FReadSurfaceDataFlags) InFlags )


description: Reads the contents of a texture to an output buffer (non MSAA and MSAA) and returns it as aFColorarray. If the format or texture type is unsupported the OutData array will be size 0

code: virtual void RHIReadSurfaceData ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, FIntRect Rect, [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > & OutData, [FReadSurfaceDataFlags](API\Runtime\RHI\FReadSurfaceDataFlags) InFlags )


code: virtual void RHIReadSurfaceFloatData ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, FIntRect Rect, [TArray](API\Runtime\Core\Containers\TArray)< [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) > & OutData, ECubeFace CubeFace, int32 ArrayIndex, int32 MipIndex )


description: Check if PSO Initializers are the same used during PSO Precaching (only compare data relevant for the RHI specific PSO)

code: virtual bool RHIMatchPrecachePSOInitializers ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & LHS, const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & RHS )


description: FlushType: Flush RHI Thread.


code: virtual void RHIRegisterWork ( uint32 NumPrimitives )


code: virtual void RHIReleaseTransition ( [FRHITransition](API\Runtime\RHI\FRHITransition) * Transition )


code: virtual bool RHIRequiresComputeGenerateMips() const


description: Must be called from the main thread. FlushType: Thread safe

code: virtual void RHIResizeViewport ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport, uint32 SizeX, uint32 SizeY, bool bIsFullscreen )


code: virtual void RHIResizeViewport ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport, uint32 SizeX, uint32 SizeY, bool bIsFullscreen, EPixelFormat PreferredPixelFormat )


description: FlushType: Thread safe.

code: virtual void RHIResumeRendering()


code: virtual void RHISetImageLayout ( VkImage Image, VkImageLayout OldLayout, VkImageLayout NewLayout, const VkImageSubresourceRange & SubresourceRange )


code: virtual void RHISetUploadImageLayout ( VkImage Image, VkImageLayout OldLayout, VkImageLayout NewLayout, const VkImageSubresourceRange & SubresourceRange )


description: Called by the RHI thread.

code: virtual void RHISubmitCommandLists ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [IRHIPlatformCommandList](API\Runtime\RHI\IRHIPlatformCommandList) * > CommandLists, bool bFlushResources )


description: Kicks the current frame and makes sure GPU is actively working on them FlushType: Flush Immediate (copied from RHIBlockUntilGPUIdle)


code: virtual bool RHISupportsEXTFragmentDensityMap2() const


description: Operations to suspend title rendering and yield control to the system FlushType: Thread safe

code: virtual void RHISuspendRendering()


code: virtual void RHITick ( float DeltaTime )


description: FlushType: Flush RHI Thread.

code: virtual void RHIUnlockBuffer ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer )


description: Transfer metadata and underlying resource from src to dest and release any resource owned by dest.

code: virtual void RHITransferBufferUnderlyingResource ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * DestBuffer, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SrcBuffer )


description: Unlocks a previously locked RHI texture resource

code: virtual void RHIUnlockTexture2D ( FRHITexture2D * Texture, uint32 MipIndex, bool bLockWithinMiptail )


description: Unlock a staging buffer previously locked with RHILockStagingBuffer.

code: virtual void RHIUnlockStagingBuffer ( [FRHIStagingBuffer](API\Runtime\RHI\FRHIStagingBuffer) * StagingBuffer )


code: virtual void RHIUnlockTexture2DArray ( FRHITexture2DArray * Texture, uint32 TextureIndex, uint32 MipIndex, bool bLockWithinMiptail )


description: Call after a succesfulRHIMapStagingSurface()call

code: virtual void RHIUnmapStagingSurface ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, uint32 GPUIndex )


code: virtual void RHIUnlockTextureCubeFace ( FRHITextureCube * Texture, uint32 FaceIndex, uint32 ArrayIndex, uint32 MipIndex, bool bLockWithinMiptail )


description: Updates a region of a 2D texture from system memory

code: virtual void RHIUpdateTexture2D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FRHITexture2D * Texture, uint32 MipIndex, const struct [FUpdateTextureRegion2D](API\Runtime\RHI\FUpdateTextureRegion2D) & UpdateRegion, uint32 SourcePitch, const uint8 * SourceData )


code: virtual void RHIUpdateTextureReference ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHITextureReference](API\Runtime\RHI\FRHITextureReference) * TextureRef, [FRHITexture](API\Runtime\RHI\FRHITexture) * NewTexture )


code: virtual void RHIUpdateUniformBuffer ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * UniformBufferRHI, const void * Contents )


description: Updates a region of a 3D texture from system memory

code: virtual void RHIUpdateTexture3D ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FRHITexture3D * Texture, uint32 MipIndex, const struct [FUpdateTextureRegion3D](API\Runtime\RHI\FUpdateTextureRegion3D) & UpdateRegion, uint32 SourceRowPitch, uint32 SourceDepthPitch, const uint8 * SourceData )


code: static void SavePipelineCache()


code: virtual void RHIVerifyResult ( VkResult Result, const ANSICHAR * VkFuntion, const ANSICHAR * Filename, uint32 Line )


description: Static void WriteEndFrameTimestamp(void*);

code: [TArray](API\Runtime\Core\Containers\TArray)< const ANSICHAR * > SetupInstanceLayers ( FVulkanInstanceExtensionArray & UEExtensions )


code: static void SetupValidationRequests()


description: Shutdown the RHI; handle shutdown and resource destruction before the RHI's actual destructor is called (so that all resources of the RHI are still available for shutdown).

code: virtual void Shutdown()


code: bool SupportsDebugUtilsExt() const


code: virtual void UnlockBuffer_BottomOfPipe ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer )


code: virtual void UnlockTexture2D_RenderThread ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * Texture, uint32 MipIndex, bool bLockWithinMiptail, bool bNeedsDefaultRHIFlush )


description: Initialization constructor.

code: FVulkanDynamicRHI()


code: void VulkanSetImageLayout ( VkCommandBuffer CmdBuffer, VkImage Image, VkImageLayout OldLayout, VkImageLayout NewLayout, const VkImageSubresourceRange & SubresourceRange )


description: Destructor

code: ~FVulkanDynamicRHI()


code: void UpdateUniformBuffer ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, FVulkanUniformBuffer * UniformBuffer, const void * Contents )


description: Creates a new instance of the dynamic RHI implemented by the module.

code: virtual [FDynamicRHI](API\Runtime\RHI\FDynamicRHI) * CreateRHI ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) RequestedFeatureLevel )


className: FVulkanDynamicRHI

description: The interface which is implemented by the dynamically bound RHI.

code: class FVulkanDynamicRHI : public [IVulkanDynamicRHI](API\Runtime\VulkanRHI\IVulkanDynamicRHI)

ActiveDebugLayerExtension

type: EActiveDebugLay...

Device

type: FVulkanDevice &...

DrawingViewport

type: TRefCountPtr< F...

description: The viewport which is currently being drawn.

Instance

type: VkInstance

InstanceExtensions

type: TArray< const A...

LockBufferCS

type: FCriticalSectio...

OptionalInstanceExtensions

type: FOptionalVulkan...

RebuildPipelineCacheCmd

type: IConsoleObject...

TotalPresentCount

description: Historical number of times we've presented any and all viewports.

Viewports

type: TArray< FVulkan...

description: A list of all viewport RHIs that have been created.


code: virtual bool IsSupported ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) RequestedFeatureLevel )


description: IDynamicRHIModule.

code: virtual bool IsSupported()


className: FVulkanDynamicRHIModule

description: Implements the Vulkan module as a dynamic RHI providing module.

code: class FVulkanDynamicRHIModule : public [IDynamicRHIModule](API\Runtime\RHI\IDynamicRHIModule)


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FVulkanRHIImageViewInfo

code: struct FVulkanRHIImageViewInfo

Format

type: VkFormat

Image

type: VkImage

ImageView

type: VkImageView

SubresourceRange

type: VkImageSubresou...

UEFlags

type: ETextureCreateF...


className: EAttachmentType

code: enum EAttachmentType { Color0, Color1, Color2, Color3, Color4, Color5, Color6, Color7, Depth, Count, }


className: FVulkanRHIAllocationInfo

code: struct FVulkanRHIAllocationInfo

Handle

type: VkDeviceMemory


className: EType

code: enum EType { PackedGlobal, Global, UniformBuffer, Count, }


className: FInputAttachment

code: struct FInputAttachment

Type

type: EAttachmentType


className: FGlobalInfo

code: struct FGlobalInfo

bImmutableSampler

description: 1 if this is an immutable sampler

CombinedSamplerStateAliasIndex

description: If this is UINT16_MAX, it's a regular parameter, otherwise this is the SamplerState portion for a CombinedImageSampler and this is the index into Global for the Texture portion


className: FPackedGlobalInfo

code: struct FPackedGlobalInfo


className: FPackedUBInfo

code: struct FPackedUBInfo


code: FSpirvInfo &40; uint32 InDescriptorSetOffset, uint32 InBindingIndexOffset &41;


className: FUBResourceInfo

code: struct FUBResourceInfo

GlobalIndex

description: Indexinto the Global Array.

UBBaseType

type: TEnumAsByte< EU...


className: FUniformBufferInfo

code: struct FUniformBufferInfo

ResourceEntries

type: TArray<FUBReso...

description: Uint32 ConstantDataSizeInBytes;


code: FVulkanShaderHeader ( [EInit](API\Runtime\VulkanRHI\FVulkanShaderHeader\EInit) )


code: static void AddEnabledDeviceExtensionsAndLayers ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const ANSICHAR *const > InDeviceExtensions, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const ANSICHAR *const > InDeviceLayers )


className: FVulkanShaderHeader

description: Vulkan ParameterMap: BufferIndex= EBufferIndex Base Offset =Indexinto the subtype Size = Ignored for non-globals

code: struct FVulkanShaderHeader

DebugName

type: FString

EmulatedUBCopyRanges

type: TArray< uint32 ...

description: Number of copies per emulated buffer source index (to skip searching among UniformBuffersCopyInfo). Upper uint16 is the index, Lower uint16 is the count.

EmulatedUBsCopyInfo

type: TArray<CrossCo...

GlobalDescriptorTypes

type: TArray<TEnumAs...

Globals

type: TArray<FGlobal...

GlobalSpirvInfos

type: TArray<FSpirvI...

InOutMask

description: Mostly relevant for Vertex Shaders.

InputAttachments

type: TArray<FInputA...

PackedGlobals

type: TArray<FPacked...

RayTracingPayloadType

description: Relevant for Ray Tracing Shaders.

SourceHash

type: FSHAHash

UniformBuffers

type: TArray<FUnifor...


code: static void AddEnabledInstanceExtensionsAndLayers ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const ANSICHAR *const > InInstanceExtensions, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const ANSICHAR *const > InInstanceLayers )


code: virtual ERHIInterfaceType GetInterfaceType() const


code: FTexture2DArrayRHIRef RHICreateTexture2DArrayFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 ArraySize, uint32 NumMips, uint32 NumSamples, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: FTexture2DRHIRef RHICreateTexture2DFromResource ( EPixelFormat Format, uint32 SizeX, uint32 SizeY, uint32 NumMips, uint32 NumSamples, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: FTextureCubeRHIRef RHICreateTextureCubeFromResource ( EPixelFormat Format, uint32 Size, bool bArray, uint32 ArraySize, uint32 NumMips, VkImage Resource, ETextureCreateFlags Flags, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & ClearValueBinding )


code: bool RHIDoesAdapterMatchDevice ( const void * InAdapterId ) const


description: Deprecated* Altering image layout tracking directly is not permitted anymore.

code: VkImageLayout & RHIFindOrAddLayoutRW ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, VkImageLayout LayoutIfNotFound )


code: void RHIFinishExternalComputeWork ( VkCommandBuffer InCommandBuffer )


code: [TArray](API\Runtime\Core\Containers\TArray)< VkExtensionProperties > RHIGetAllDeviceExtensions ( VkPhysicalDevice InPhysicalDevice ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< VkExtensionProperties > RHIGetAllInstanceExtensions() const


code: [FVulkanRHIAllocationInfo](API\Runtime\VulkanRHI\FVulkanRHIAllocationInfo) RHIGetAllocationInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: uint64 RHIGetGraphicsAdapterLUID ( VkPhysicalDevice InPhysicalDevice ) const


code: uint32 RHIGetGraphicsQueueIndex() const


code: [FVulkanRHIImageViewInfo](API\Runtime\VulkanRHI\FVulkanRHIImageViewInfo) RHIGetImageViewInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: VkQueue RHIGetGraphicsVkQueue() const


code: VkFormat RHIGetSwapChainVkFormat ( EPixelFormat InFormat ) const


code: VkFormat RHIGetViewVkFormat ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: VkDevice RHIGetVkDevice() const


code: const VkAllocationCallbacks * RHIGetVkAllocationCallbacks()


code: VkImage RHIGetVkImage ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture ) const


code: VkInstance RHIGetVkInstance() const


code: const uint8 * RHIGetVulkanDeviceUUID() const


code: void RHIRegisterWork ( uint32 NumPrimitives )


code: uint32 RHIGetVulkanVersion() const


code: void RHISetImageLayout ( VkImage Image, VkImageLayout OldLayout, VkImageLayout NewLayout, const VkImageSubresourceRange & SubresourceRange )


code: void * RHIGetVkDeviceProcAddr ( const char * InName ) const


code: void RHISetUploadImageLayout ( VkImage Image, VkImageLayout OldLayout, VkImageLayout NewLayout, const VkImageSubresourceRange & SubresourceRange )


className: IVulkanDynamicRHI

code: struct IVulkanDynamicRHI : public [FDynamicRHI](API\Runtime\RHI\FDynamicRHI)


code: void RHISubmitUploadCommandBuffer()


code: void RHIVerifyResult ( VkResult Result, const ANSICHAR * VkFuntion, const ANSICHAR * Filename, uint32 Line )


code: namespace ShaderStage { enum EStage { Vertex = 0, Pixel = 1, Geometry = 2, NumGeometryStages = 1, NumRayTracingStages = 0, NumStages = (2 + NumGeometryStages + NumRayTracingStages), Compute = 0, MaxNumSets = 8, Invalid = -1, } }


code: namespace ShaderStage { EShaderFrequency ShaderStage::GetFrequencyForGfxStage ( [EStage](API\Runtime\VulkanRHI\ShaderStage__EStage) Stage ) }


code: namespace ShaderStage { [EStage](API\Runtime\VulkanRHI\ShaderStage__EStage) ShaderStage::GetStageForFrequency ( EShaderFrequency Stage ) }


code: template<class ArchiveWriter> void GenerateFromArchive ( ArchiveWriter && WriteToArchive, int32 DataReserve )


code: void GenerateFromData ( const void * InData, uint32 InSize )


code: template<class ObjectType> void GenerateFromObject ( const ObjectType & Object )


className: TDataKey

code: template<class Derived, bool AlwaysCompareData> class TDataKey : public [TDataKeyBase< AlwaysCompareData?2:(1!=0)>](API\Runtime\VulkanRHI\TDataKeyBase)


className: TDataKeyBase

code: template<int Version> class TDataKeyBase


className: TDataKeyBase< 0 >::CopyDataShallow

code: void CopyDataShallow &40; TDataKeyBase & Result &41; const


className: TDataKeyBase< 0 >::GetData

code: template<class DataReceiver> void GetData &40; DataReceiver && ReceiveData &41;


className: TDataKeyBase< 0 >::CopyDataDeep

code: void CopyDataDeep &40; TDataKeyBase & Result &41; const


className: TDataKeyBase< 0 >::IsDataEquals

code: bool IsDataEquals &40; const TDataKeyBase & Other &41; const


className: TDataKeyBase< 0 >

code: template<> class TDataKeyBase< 0 >


className: TDataKeyBase< 1 >::CopyDataDeep


className: TDataKeyBase< 1 >::CopyDataShallow


className: TDataKeyBase< 1 >::IsDataEquals


className: TDataKeyBase< 1 >::GetDataRef

code: TArray< uint8 > & GetDataRef&40;&41;


className: TDataKeyBase< 1 >::GetData


className: TDataKeyBase< 1 >::SetData

code: void SetData &40; const void &42; InData, uint32 InSize &41;


className: TDataKeyBase< 0 >::SetData


className: TDataKeyBase< 2 >

code: template<> class TDataKeyBase< 2 > : public [TDataKeyBase< 1 >](API\Runtime\VulkanRHI\TDataKeyBase_1)


code: namespace VulkanBindless { enum EDescriptorSets { BindlessSamplerSet = 0, BindlessStorageBufferSet, BindlessUniformBufferSet, BindlessStorageImageSet, BindlessSampledImageSet, BindlessStorageTexelBufferSet, BindlessUniformTexelBufferSet, BindlessAccelerationStructureSet, BindlessSingleUseUniformBufferSet, NumBindlessSets, MaxNumSets = NumBindlessSets, } }


description: Prefix used to declare arrays of samplers/resources for bindless.

code: namespace VulkanBindless { static constexpr const TCHAR * VulkanBindless::kBindlessResourceArrayPrefix = TEXT("ResourceDescriptorHeap_"); }


code: namespace VulkanBindless { static constexpr const TCHAR * VulkanBindless::kBindlessSamplerArrayPrefix = TEXT("SamplerDescriptorHeap_"); }


className: TDataKeyBase< 1 >

code: template<> class TDataKeyBase< 1 >

Data

type: TArray< uint8 >...


className: TDataKeyBase< 2 >::IsDataEquals


code: namespace VulkanRHI { static const VkAllocationCallbacks * VulkanRHI::GetMemoryAllocator ( const VkAllocationCallbacks * Allocator ) }


module: WebBrowser

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


className: FBrowserContextSettings

code: struct FBrowserContextSettings

bEnableNetSecurityExpiration

type: bool

OnBeforeContextResourceLoad

type: FOnBeforeContex...


code: FCreateBrowserWindowSettings()


code: namespace VulkanBindless { static constexpr uint32 VulkanBindless::MaxUniformBuffersPerStage = 8; }


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > Create ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * JSBridge, bool IsPermanent )


className: FCreateBrowserWindowSettings

code: struct FCreateBrowserWindowSettings

AltRetryDomains

type: TArray<FString...

BackgroundColor

type: FColor

BrowserFrameRate

type: int

ContentsToLoad

type: TOptional<FStr...

Context

type: TOptional<FBro...

OSWindowHandle

type: void *


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > Create ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * JSBridge, bool IsPermanent, const [FString](API\Runtime\Core\Containers\FString) & ConnectScriptText, const [FString](API\Runtime\Core\Containers\FString) & DisconnectScriptText )


className: FWebBrowserAdapterFactory

code: class FWebBrowserAdapterFactory


className: FWebBrowserCookie

code: struct FWebBrowserCookie

bHasExpires

description: If true the cookie will expire at the specified Expires datetime.

bHttpOnly

description: If true the cookie will only be sent for HTTP requests.

bSecure

description: If true the cookie will only be sent for HTTPS requests.

Domain

type: FString

description: If is empty a host cookie will be created instead of a domain cookie.

Expires

type: FDateTime

description: The cookie expiration date is only valid if bHasExpires is true.

Name

description: The cookie name.

Path

description: If is non-empty only URLs at or below the path will get the cookie value.

Value

description: The cookie value.


description: Default constructor. Initializes all members with default behavior values.

code: FWebBrowserInitSettings()


className: FWebBrowserInitSettings

description: WebBrowser initialization settings, can be used to override default init behaviors.

code: struct FWebBrowserInitSettings

ProductVersion

description: The string which is appended to the browser's user-agent value.


description: Returns the size of the viewport

code: virtual FIntPoint GetSize() const


description: Returns a slate texture used to draw the rendered viewport in Slate.

code: virtual [FSlateShaderResource](API\Runtime\SlateCore\Textures\FSlateShaderResource) * GetViewportRenderTargetTexture() const


description: Called when Slate needs to know what the mouse cursor should be.FCursorReply::Unhandled()if the event is not handled;FCursorReply::Cursor()otherwise.

code: virtual [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent )


description: Called when the viewport loses keyboard focus.

code: virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description: Called when the viewport gains keyboard focus.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
Called by Slate when a character key is pressed while the viewport has focus
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


description:
Called by Slate when a key is pressed inside the viewport
Whether the event was handled along with possible requests for the system to take action.

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


description:
Called by Slate when a key is released inside the viewport
Whether the event was handled along with possible requests for the system to take action.

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


description:
Called by Slate when the mouse wheel is used inside the viewport
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description:
Called by Slate when a mouse button is pressed inside the viewport
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
Called by Slate when a mouse button is released inside the viewport
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Called on a touchpad gesture event

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchGesture ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InGestureEvent )


description: Returns true if the viewport should be vsynced.

code: virtual bool RequiresVsync() const


description: Performs any ticking necessary by this handle

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


description: Default Constructor

code: FWebBrowserViewport ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > InWebBrowserWindow, bool InIsPopup )


description: Destructor.

code: ~FWebBrowserViewport()


className: FWebBrowserViewport

description: A Slate viewport to display a Web Browser Window

code: class FWebBrowserViewport : public [ISlateViewport](API\Runtime\SlateCore\Rendering\ISlateViewport)


code: void Invoke ( int32 ArgCount, [FWebJSParam](API\Runtime\WebBrowser\FWebJSParam) Arguments, bool bIsError ) const


code: FWebJSCallbackBase ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FWebJSScripting > InScripting, const [FGuid](API\Runtime\Core\Misc\FGuid) & InCallbackId )


className: FWebJSCallbackBase

description: Base class for JS callback objects.

code: struct FWebJSCallbackBase


code: template<typename... ArgTypes> void operator() ( ArgTypes... Args ) const


code: FWebJSFunction ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FWebJSScripting > InScripting, const [FGuid](API\Runtime\Core\Misc\FGuid) & InFunctionId )


className: FWebJSFunction

description: Representation of a remote JS function.FWebJSFunctionobjects represent a JS function and allow calling them from native code.FWebJSFunctionobjects can also be added to delegates and events using the Bind/AddLambda method.

code: struct FWebJSFunction : public [FWebJSCallbackBase](API\Runtime\WebBrowser\FWebJSCallbackBase)


code: virtual const void &42; GetData&40;&41;


code: virtual IStructWrapper &42; Clone&40;&41;


code: FStructWrapper &40; const T & InValue &41;


code: virtual UStruct &42; GetTypeInfo&40;&41;


code: virtual &126;FStructWrapper&40;&41;


className: FStructWrapper

code: template<typename T> struct FStructWrapper : public [FWebJSParam::IStructWrapper](API\Runtime\WebBrowser\FWebJSParam\IStructWrapper)

StructValue

type: T


code: IStructWrapper &42; Clone&40;&41;


code: const void &42; GetData&40;&41;


code: UStruct &42; GetTypeInfo&40;&41;


code: virtual &126;IStructWrapper&40;&41;


className: IStructWrapper

code: struct IStructWrapper


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


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


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


code: FWebJSParam ( const TCHAR * Value )


code: FWebJSParam ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Value )


code: template<typename T> FWebJSParam ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), T > & Value )


code: template<typename T> FWebJSParam ( const [TArray](API\Runtime\Core\Containers\TArray)< T > & Value )


code: template<typename K, typename T> FWebJSParam ( const [TMap](API\Runtime\Core\Containers\TMap)< K, T > & Value )


code: FWebJSParam ( const [FWebJSParam](API\Runtime\WebBrowser\FWebJSParam) & Other )


code: FWebJSParam ( [FWebJSParam](API\Runtime\WebBrowser\FWebJSParam) && Other )


code: template<typename T> FWebJSParam ( const T & Value, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)<![TIsPointer](API\Runtime\Core\Templates\TIsPointer)< T >::Value, [UStruct](API\Runtime\CoreUObject\UObject\UStruct) >::Type * InTypeInfo )


className: FWebJSParam

code: struct FWebJSParam

type: union FWebJSPar...

ArrayValue

type: TArray<FWebJSP...

DoubleValue

type: double

MapValue

type: TMap<FString, ...

ObjectValue

type: UObject*

StringValue

type: constFString&...

type: IStructWrapper...

Tag

type: enum FWebJSPara...


description: Indicate failed completion, passing an error message back to JS. The remote Promise's catch() handler will be executed with the value passed as the error reason.

code: template<typename T> void Failure ( T Arg ) const


description: Indicate successful completion without a return value. The remote Promise's then() handler will be executed without arguments.

code: void Success() const


description: Indicate successful completion passing a return value back. The remote Promise's then() handler will be executed with the value passed as its single argument.

code: template<typename T> void Success ( T Arg ) const


code: FWebJSResponse ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FWebJSScripting > InScripting, const [FGuid](API\Runtime\Core\Misc\FGuid) & InCallbackId )


className: FWebNavigationRequest

code: struct FWebNavigationRequest

bIsExplicitTransition

type: bool

TransitionSource

type: EWebTransitionS...


className: FWebJSResponse

description: Note that the remote object will become invalid as soon as a result has been delivered, so you can only call either Success or Failure once.

code: struct FWebJSResponse : public [FWebJSCallbackBase](API\Runtime\WebBrowser\FWebJSCallbackBase)


code: void ConnectTo ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > & BrowserWindow )


code: void DisconnectFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > & BrowserWindow )


className: IWebBrowserAdapter

code: class IWebBrowserAdapter


description: Removes all matching cookies. Leave both URL and CookieName blank to delete the entire cookie database. The actual deletion will be scheduled on the browser IO thread, so the operation may not have completed when the function returns.

code: void DeleteCookies ( const [FString](API\Runtime\Core\Containers\FString) & URL, const [FString](API\Runtime\Core\Containers\FString) & CookieName, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(int)> Completed )


className: FCookie

code: typedef struct [FWebBrowserCookie](API\Runtime\WebBrowser\FWebBrowserCookie) FCookie


description: This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ';' character is disallowed within the cookie Value field) and fail without setting the cookie if such characters are found.

code: void SetCookie ( const [FString](API\Runtime\Core\Containers\FString) & URL, const [FCookie](API\Runtime\WebBrowser\IWebBrowserCookieManager\FCookie) & Cookie, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(bool)> Completed )


className: IWebBrowserCookieManager

code: class IWebBrowserCookieManager


description: Tell the browser to continue with the result of the dialog. If this method is used, the original event handler must return EWebBrowserDialogEventResponse::Handled.

code: void Continue ( bool Success, const [FText](API\Runtime\Core\Internationalization\FText) & UserResponse )


description:
Only valid for Prompt dialogs.
the default value to show in the text entry box.

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


description:
Get the dialog message.
the message to show in the dialog.

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


description:
What kind of dialog should be shown.
the dialog type

code: EWebBrowserDialogType GetType()


description:
Only valid for Unload dialogs.
true if the dialog is confirming a reload of the current page.

code: bool IsReload()


className: IWebBrowserDialog

description: Browser dialog parameters passed to OnBrowserDialog event handlers.

code: class IWebBrowserDialog


description:
Customize initialization settings. You must call this before the first GetSingleton call, in order to override init settings.
true if the settings were used to initialize the singleton. False if the call was ignored due to singleton already existing.

code: bool CustomInitialize ( const [FWebBrowserInitSettings](API\Runtime\WebBrowser\FWebBrowserInitSettings) & WebBrowserInitSettings )


description:
Get or load the Web Browser Module
The loaded module

code: static [IWebBrowserModule](API\Runtime\WebBrowser\IWebBrowserModule) & Get()


description:
Get the Web Browser Singleton
The Web Browser Singleton


description:
Check whether the module has already been loaded
True if the module is loaded

code: static bool IsAvailable()


description:
Check whether the web module loaded its requirements successfully
True if the module load worked

code: bool IsWebModuleAvailable() const


className: IWebBrowserModule

description: WebBrowserModule interface

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


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


code: bool IsLocationBarVisible() const


code: bool IsScrollbarsVisible() const


code: bool IsStatusBarVisible() const


code: virtual ~IWebBrowserPopupFeatures()


className: IWebBrowserPopupFeatures

code: class IWebBrowserPopupFeatures


description: Called if the request should be canceled.

code: void Cancel()


description: Retrieves the headers for this request.

code: void GetResponseHeaders ( [IHeaders](API\Runtime\WebBrowser\IWebBrowserSchemeHandler\IHeaders) & OutHeaders )


description: Sets the content length for the response.

code: void SetContentLength &40; int32 ContentLength &41;


description: Sets a header for the response.

code: void SetHeader &40; const TCHAR &42; Key, const TCHAR &42; Value &41;


description: Sets the mime type for the response.

code: void SetMimeType &40; const TCHAR &42; MimeType &41;


description: Sets a redirect url for the response. Other calls will be ignored if this is used.

code: void SetRedirect &40; const TCHAR &42; Url &41;


description: Sets the status code for the response.

code: void SetStatusCode &40; int32 StatusCode &41;


className: IHeaders

description: An interface for setting response headers emulating a http implementation.

code: class IHeaders


description:
Process an incoming request.
You should return true if the request has been accepted and will be processed, otherwise false to cancel this request.

code: bool ProcessRequest ( const [FString](API\Runtime\Core\Containers\FString) & Verb, const [FString](API\Runtime\Core\Containers\FString) & Url, const FSimpleDelegate & OnHeadersReady )


description:
Retrieves the headers for this request.
You should return true if more data needs to be read, otherwise false if this is the end of the response data.

code: bool ReadResponse ( uint8 * OutBytes, int32 BytesToRead, int32 & BytesRead, const FSimpleDelegate & OnMoreDataReady )


className: IWebBrowserSchemeHandler

description: This is the interface that needs to be implemented to handle a request made via a custom scheme. It will be created by implementing anIWebBrowserSchemeHandlerFactory, given to the web browser singleton.

code: class IWebBrowserSchemeHandler


code: virtual ~IWebBrowserSchemeHandler()


className: IWebBrowserSchemeHandlerFactory

description: This is the interface that needs to be implemented to instantiate a scheme request handler.

code: class IWebBrowserSchemeHandlerFactory


description: Instantiates an appropriate handler for the given request details.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IWebBrowserSchemeHandler](API\Runtime\WebBrowser\IWebBrowserSchemeHandler) > Create ( [FString](API\Runtime\Core\Containers\FString) Verb, [FString](API\Runtime\Core\Containers\FString) Url )


description: the application cache dir where the cookies are stored


description: Delete old/unused web cache paths. Some Web implementations (i.e CEF) use version specific cache folders, this call lets you schedule a deletion of any now unused folders. Calling this may resulting in async disk I/O.

code: void ClearOldCacheFolders ( const [FString](API\Runtime\Core\Containers\FString) & CachePathRoot, const [FString](API\Runtime\Core\Containers\FString) & CachePrefix )


description:
Create a new web browser window
New Web Browser Window Interface (may be null if not supported)

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > CreateBrowserWindow ( const [FCreateBrowserWindowSettings](API\Runtime\WebBrowser\FCreateBrowserWindowSettings) & Settings )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > CreateBrowserWindow ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FCEFWebBrowserWindow > & BrowserWindowParent, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FWebBrowserWindowInfo > & BrowserWindowInfo )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IWebBrowserCookieManager](API\Runtime\WebBrowser\IWebBrowserCookieManager) > GetCookieManager ( [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > ContextId ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IWebBrowserCookieManager](API\Runtime\WebBrowser\IWebBrowserCookieManager) > GetCookieManager() const


description: Get a reference toUWebBrowser's default material


description: Get a reference toUWebBrowser's transparent material


description: A factory object that can be used to construct additional WebBrowserWindows on demand.


description:
The relevant handlers for spawning new browser windows have to be set up correctly in addition to this flag being true before anything is shown.
a boolean value indicating whether the keyboard shortcut is enabled or not.

code: bool IsDevToolsShortcutEnabled()


code: bool RegisterContext ( const [FBrowserContextSettings](API\Runtime\WebBrowser\FBrowserContextSettings) & Settings )


description: Registers a custom scheme handler factory, for a given scheme and domain. The domain is ignored if the scheme is not a browser built in scheme and all requests will go through this factory.

code: bool RegisterSchemeHandlerFactory ( [FString](API\Runtime\Core\Containers\FString) Scheme, [FString](API\Runtime\Core\Containers\FString) Domain, [IWebBrowserSchemeHandlerFactory](API\Runtime\WebBrowser\IWebBrowserSchemeHandlerFactory) * WebBrowserSchemeHandlerFactory )


description: Set a reference toUWebBrowser's default material

code: void SetDefaultMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InDefaultMaterial )


description: Set a reference toUWebBrowser's translucent material

code: void SetDefaultTranslucentMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InDefaultMaterial )


description: The relevant handlers for spawning new browser windows have to be set up correctly in addition to this flag being true before anything is shown.

code: void SetDevToolsShortcutEnabled ( bool Value )


description: Default behavior is enabled, so that all JS side objects have only lowercase members.

code: void SetJSBindingToLoweringEnabled ( bool bEnabled )