description: Initialization completion callback with result

code: virtual void OnInitializationCompleted ( bool bHasSucceed )


description: Called when stream is about to enqueue new frame

module: RivermaxMedia

code: virtual void OnPreFrameEnqueue()


code: virtual void OnRHIResourceCaptured_AnyThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, FBufferRHIRef InBuffer )


description: Called when stream has encountered an error and has to stop

code: virtual void OnStreamError()


description: Should we callOnFrameCaptured_RenderingThread()with a RHI resource -or- readback the memory to CPU ram and callOnFrameCaptured_RenderingThread().

code: virtual bool ShouldCaptureRHIResource() const


code: virtual void StopCaptureImpl ( bool bAllowPendingFrameToBeProcess )


description: Whether the capture callbacks can be called on any thread. If true, the _AnyThread callbacks will be used instead of the _RenderThread ones.

code: virtual bool SupportsAnyThreadCapture() const


description: Whether the capture implementation supports restarting on input format change.

code: virtual bool SupportsAutoRestart() const


code: virtual bool UpdateRenderTargetImpl ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget )


code: virtual bool UpdateSceneViewportImpl ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > & InSceneViewport )


code: virtual bool ValidateMediaOutput() const


description: Returns true if media capture implementation supports synchronization logic. If so, OnOutputSynchronization delegate below must be called before each captured frame is exported.

code: virtual bool IsOutputSynchronizationSupported() const


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


code: virtual [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture) * CreateMediaCaptureImpl()


description: The conversion we wish to accomplish on the GPU before the DMA transfer occurs.

code: virtual [EMediaCaptureConversionOperation](API\Plugins\MediaIOCore\EMediaCaptureConversionOperation) GetConversionOperation ( [EMediaCaptureSourceType](API\Plugins\MediaIOCore\EMediaCaptureSourceType) InSourceType ) const


description: The pixel format of the buffer we wish to capture. Some conversion are available. See EMediaCaptureConversionOperation

code: virtual EPixelFormat GetRequestedPixelFormat() const


description: The size of the buffer we wish to capture. The size of the buffer can not change during the capture. Return UMediaOutput::RequestCaptureSourceSize if you wish to take the buffer size as the requested size.

code: virtual FIntPoint GetRequestedSize() const


className: URivermaxMediaCapture

description: Output Media for Rivermax streams.


description:
Validate the media output settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate ( [FString](API\Runtime\Core\Containers\FString) & OutFailureReason ) const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


className: URivermaxMediaOutput

description: Output information for a Rivermax media capture.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(MediaIOCustomLayout="Rivermax", DisplayName="NVIDIA Rivermax Output")) class URivermaxMediaOutput : public [UMediaOutput](API\Plugins\MediaIOCore\UMediaOutput)

AlignmentMode

type: ERivermaxMediaA...

description: Used by frame scheduler to know how to align the output

bDoContinuousOutput

type: bool

description: Whether to produce a continuous output stream repeating last frame if no new frames provided Note: Not supported in frame creation mode

bDoFrameCounterTimestamping

description: Experimental flag to use frame counter instead of using NVIDIA Rivermax clock for timestamping output frames Meant to be used for UE-UE streams where frame locking is done, e.g. nDisplay.

bOverrideResolution

description: If false, use the default source buffer size. If true, a specific resolution will be used.

bUseGPUDirect

description: Whether to use GPUDirect if available (Memcopy from GPU to NIC directly bypassing system) if available

FrameLockingMode

type: ERivermaxFrameL...

description: For alignment point mode, controls whether we stall engine before capturing if there are no buffer available to capture into

FrameRate

type: FFrameRate

description: Frame rate of this output stream

InterfaceAddress

type: FString

description: Network card interface to use to send data Wildcards are supported to match against an interface found on the machine 192.*.0.110 192.168.0.1?0 192.168.0.1*

PixelFormat

type: ERivermaxMediaO...

description: Pixel format for this output stream

Port

description: Port to use for this output

PresentationQueueSize

description: Number of frames that can be queued / used in output queue. Frame being sent counts for 1.

Resolution

type: FIntPoint

description: Resolution of this output stream

StreamAddress

description: Address of the stream. Can be multicast, i.e. 224.1.1.1)


description:
Get a Boolean media option.
The option value.

code: virtual bool GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool DefaultValue ) const


description:
Get a signed integer media option.
The option value.

code: virtual int64 GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 DefaultValue ) const


description:
Get a string media option.
The option value.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue ) const


description:
Check whether the specified option is set.
true if the option is set, false otherwise.

code: virtual bool HasMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


className: URivermaxMediaSource

description: Media source for Rivermax streams.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="Rivermax", DisplayName="NVIDIA Rivermax Source")) class URivermaxMediaSource : public [UTimeSynchronizableMediaSource](API\Runtime\MediaAssets\UTimeSynchronizableMediaSource)

bIsSRGBInput

description: Whether the video input is in sRGB color space.If true, sRGBToLinear will be done on incoming pixels before writing to media texture

bUseGPUDirect

description: Whether to use GPUDirect if available (Memcopy from NIC to GPU directly bypassing system memory) if available

bUseZeroLatency

description: If true, when looking for the sample to render, the current frame number will be looked for.

FrameRate

description: Incoming stream video frame rate

InterfaceAddress

description: Network card interface to use to receive data Wildcards are supported to match against an interface found on the machine 192.*.0.110 192.168.0.1?0 192.168.0.1*

PixelFormat

type: ERivermaxMediaS...

description: Incoming stream pixel format

PlayerMode

type: ERivermaxPlayer...

description: Player mode to be used.

Port

description: Port used by the sender to send its stream

Resolution

description: Incoming stream video resolution

description: IP address where incoming stream is coming from


description: Allocates and setup shader parameter in the incoming graph builder

module: RivermaxRendering

code: [FRGB10BitToRGBA10CS::FParameters](API\Plugins\RivermaxRendering\FRGB10BitToRGBA10CS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef RGBBuffer, FRDGTextureRef OutputTexture, int32 TotalElementCount, int32 BufferLineCount )


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


description: GetProxies

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


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


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


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdOutputTextureSizeX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters

InputBuffer

type: TShaderResource...

OutputTextureSizeX

type: TShaderParamete...


description: Structure definition to match StructuredBuffer in RivermaxShaders.usf 10 bits per channel, 30 bits per pixel. Aligns on 15 32bits -> 480bits -> 16RGB10 pixels 2110-20 says it's 4 pixels per pgroup.

code: struct FRGB10BitBuffer


className: DefineName

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


className: FSRGBToLinear

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


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


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGB10BitToRGBA10CS](API\Plugins\RivermaxRendering\FRGB10BitToRGBA10CS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


description: Called by the engine to determine which permutations to compile for this shader.

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


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


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


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


description: Compute shader to convert packed 10 bits RGB to RGBA

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


code: [FRGB12BitToRGBA12CS::FParameters](API\Plugins\RivermaxRendering\FRGB12BitToRGBA12CS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef RGBBuffer, FRDGTextureRef OutputTexture, int32 TotalElementCount, int32 BufferLineCount )


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdOutputTextureSizeX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


className: DefineName

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


description: Structure definition to match StructuredBuffer in RivermaxShaders.usf 12 bits per channel, 36 bits per pixel. Aligns on 9 32bits -> 288bits -> 8x RGB12 pixels 2110-20 says it's 2 pixels per pgroup.

code: struct FRGB12BitBuffer


className: FSRGBToLinear

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


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGB12BitToRGBA12CS](API\Plugins\RivermaxRendering\FRGB12BitToRGBA12CS) >::Type InternalBaseType


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


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


description: Compute shader to convert packed 12 bits RGB to RGBA

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


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


code: [FRGB16fBitToRGBA16fCS::FParameters](API\Plugins\RivermaxRendering\FRGB16fBitToRGBA16fCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef RGBBuffer, FRDGTextureRef OutputTexture, int32 TotalElementCount, int32 BufferLineCount )


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


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


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdOutputTextureSizeX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


description: Structure definition to match StructuredBuffer in RivermaxShaders.usf To align on 32bits, use 2 pixels (16 bit * 3 * 2 = 3x32bits)

code: struct FRGB16fBuffer


className: DefineName

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


className: FSRGBToLinear

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


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


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


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGB16fBitToRGBA16fCS](API\Plugins\RivermaxRendering\FRGB16fBitToRGBA16fCS) >::Type InternalBaseType


className: InterfaceType

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


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


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


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


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


description: Compute shader to convert 16 bits float RGB to RGBA

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


code: [FRGB8BitToRGBA8CS::FParameters](API\Plugins\RivermaxRendering\FRGB8BitToRGBA8CS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef RGBBuffer, FRDGTextureRef OutputTexture, int32 TotalElementCount, int32 BufferLineCount )


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


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileName

code: static FileName = builtin_FILE();


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


className: FileLine

code: static FileLine = builtin_LINE();


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdTotalElementCount


className: zzMemberIdOutputTextureSizeX


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


description: Structure definition to match StructuredBuffer in RivermaxShaders.usf For 8bit output, it's 3 bytes per pixels. To align with 4 bytes (32bit) we use 12 bytes (4 pixels) per output

code: struct FRGB8BitBuffer


className: DefineName

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


className: FSRGBToLinear

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


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


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGB8BitToRGBA8CS](API\Plugins\RivermaxRendering\FRGB8BitToRGBA8CS) >::Type InternalBaseType


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


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


description: Compute shader to convert packed 8 bits RGB to RGBA 8bits

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


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


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


code: [FRGBToRGB10BitCS::FParameters](API\Plugins\RivermaxRendering\FRGBToRGB10BitCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, FRDGBufferRef OutputBuffer )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileName

code: static FileName = builtin_FILE();


className: FileLine

code: static FileLine = builtin_LINE();


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


className: NumElements

code: static NumElements = 0;


className: NumColumns

code: static NumColumns = 1;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdOnePixelDeltaX


className: zzMemberIdOnePixelDeltaY


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: struct FRGB10BitBuffer


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


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGBToRGB10BitCS](API\Plugins\RivermaxRendering\FRGBToRGB10BitCS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


description: Compute shader to convert RGBA to packed 10 bits RGB

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


code: [FRGBToRGB12BitCS::FParameters](API\Plugins\RivermaxRendering\FRGBToRGB12BitCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, FRDGBufferRef OutputBuffer )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


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


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


className: Alignment

code: static Alignment = 16;


className: FileLine

code: static FileLine = builtin_LINE();


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


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


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


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdOnePixelDeltaX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: zzMemberIdOnePixelDeltaY


code: struct FRGB12BitBuffer


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


className: FParameters

code: class FParameters


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGBToRGB12BitCS](API\Plugins\RivermaxRendering\FRGBToRGB12BitCS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


description: Compute shader to convert RGBA to packed 12 bits RGB

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


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


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


code: [FRGBToRGB16fCS::FParameters](API\Plugins\RivermaxRendering\FRGBToRGB16fCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, FRDGBufferRef OutputBuffer )


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdOnePixelDeltaX


className: zzMemberIdOnePixelDeltaY


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: struct FRGB16fBuffer


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


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


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGBToRGB16fCS](API\Plugins\RivermaxRendering\FRGBToRGB16fCS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


description: Compute shader to convert RGBA to Float16 RGB

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


code: [FRGBToRGB8BitCS::FParameters](API\Plugins\RivermaxRendering\FRGBToRGB8BitCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, FRDGBufferRef OutputBuffer )


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdOnePixelDeltaX


className: zzMemberIdOnePixelDeltaY


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: struct FRGB8BitBuffer


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


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


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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGBToRGB8BitCS](API\Plugins\RivermaxRendering\FRGBToRGB8BitCS) >::Type InternalBaseType


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


className: InterfaceType

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


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


description: Compute shader to convert RGBA to packed 8 bits RGB

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


code: [FRGBToYUV10Bit422LittleEndianCS::FParameters](API\Plugins\RivermaxRendering\FRGBToYUV10Bit422LittleEndianCS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, const FMatrix & ColorTransform, const FVector & YUVOffset, bool bDoLinearToSrgb, FRDGBufferRef OutputBuffer )


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdOnePixelDeltaY


className: zzMemberIdOutYCbCrBuffer


className: zzMemberIdRGBToYUVConversion


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters

RGBToYUVConversion

type: FRGBToYUVConver...


description: Structure definition to match StructuredBuffer in RivermaxShaders.usf.

code: struct FYUV10Bit422LEBuffer


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


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


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


className: InterfaceType

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


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


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

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


code: [FRGBToYUV8Bit422CS::FParameters](API\Plugins\RivermaxRendering\FRGBToYUV8Bit422CS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGTextureRef SourceTexture, const FIntPoint & CaptureSize, const FIntRect & SourceViewRect, const FIntPoint & OutputSize, const FMatrix & ColorTransform, const FVector & YUVOffset, bool bDoLinearToSrgb, FRDGBufferRef OutputBuffer )


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


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


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCapturedSizeX


className: zzMemberIdInputPixelOffsetX


className: zzMemberIdInputPixelOffsetY


className: zzMemberIdRGBToYUVConversion


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


code: struct FYUV8Bit422Buffer


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


className: zzMemberIdOnePixelDeltaY


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


className: InterfaceType

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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FRGBToYUV8Bit422CS](API\Plugins\RivermaxRendering\FRGBToYUV8Bit422CS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


description: Compute shader to convert RGB to YUV422 8 bits

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


description: Allocates and setup shader parameter in the incoming graph builder

code: [FYUV10Bit422ToRGBACS::FParameters](API\Plugins\RivermaxRendering\FYUV10Bit422ToRGBACS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef YUVBuffer, FRDGTextureRef OutputTexture, const FMatrix & ColorTransform, const FVector & YUVOffset, int32 TotalElementCount, int32 BufferLineCount )


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


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


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


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdColorTransform


className: zzMemberIdInputYCbCrBuffer


className: zzMemberIdOutputTextureSizeX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


className: DefineName

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


className: FSRGBToLinear

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


code: struct FYUV10Bit422LEBuffer


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


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


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


className: InterfaceType

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


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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FYUV10Bit422ToRGBACS](API\Plugins\RivermaxRendering\FYUV10Bit422ToRGBACS) >::Type InternalBaseType


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


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


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


code: [FYUV8Bit422ToRGBACS::FParameters](API\Plugins\RivermaxRendering\FYUV8Bit422ToRGBACS\FParameters) * AllocateAndSetParameters ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef YUVBuffer, FRDGTextureRef OutputTexture, const FMatrix & ColorTransform, const FVector & YUVOffset, int32 TotalElementCount, int32 BufferLineCount )


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


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


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


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


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


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


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


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


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdColorTransform


className: zzMemberIdOutputTextureSizeX


className: zzMemberIdTotalElementCount


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


className: FSRGBToLinear

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


className: DefineName

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


code: struct FYUV8Bit422Buffer


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


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


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


className: InterfaceType

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


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


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FYUV8Bit422ToRGBACS](API\Plugins\RivermaxRendering\FYUV8Bit422ToRGBACS) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


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


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


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


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


description: Compute shader to convert 2110 YUV8 to RGBA

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


description: Returns the policy config class used to create this policy handler.

module: RivermaxSync


description: Returns amount of time before next synchronization point.


description: Returns true if specified media capture type can be synchonized by the policy implementation

code: virtual bool IsCaptureTypeSupported ( [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture) * MediaCapture ) const


code: FMediaOutputSynchronizationPolicyRivermaxHandler ( [UMediaOutputSynchronizationPolicyRivermax](API\Plugins\RivermaxSync\UMediaOutputSynchronizationPolic-) * InPolicyObject )


description: Synchronization logic handler class forUMediaOutputSynchronizationPolicyRivermax.


description: Returns the handler associated with this policy config object


description: Rivermax media synchronization policy implementation

Handler

type: TSharedPtr<IDi...


description: Returns the beautified test name

module: RuntimeTests

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


description:
Pure virtual method; returns the number of participants for this test
Number of required participants

code: virtual uint32 GetRequiredDeviceNum() const


description:
Pure virtual method; returns the flags associated with the given automation test
Automation test flags associated with the test

code: virtual uint32 GetTestFlags() const


description: Requests a enumeration of all shader vars to be tested

code: virtual void GetTests ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutBeautifiedNames, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutTestCommands ) const


description: Gets the filename where this test was defined.

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


code: virtual bool IsStressTest() const


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


description:
Execute the comparison for the given shader var
TRUE if deemed that the performance benefit outweighs the visual cost. FALSE otherwise.

code: virtual bool RunTest ( const [FString](API\Runtime\Core\Containers\FString) & Parameters )


className: FCompareBasepassShaders

description: CompareAllShaderVars Comparison automation test the determines which shader variables need extra precision

code: class FCompareBasepassShaders : public [FAutomationTestBase](API\Runtime\Core\Misc\FAutomationTestBase)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FRuntimeTestsModule

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


description: Gets the line number where this test was defined.

code: virtual int32 GetTestSourceFileLine() const


module: SampleToolsEditorMode

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > > > GetCommands()


description: Pure virtual to override; describe and instantiate the commands in here by using the UI COMMAND macro.

code: virtual void RegisterCommands()


className: FSampleToolsEditorModeCommands

code: class FSampleToolsEditorModeCommands : public [TCommands< FSampleToolsEditorModeCommands >](API\Runtime\Slate\Framework\Commands\TCommands)

Commands

type: TMap<FName,TA...

CreateActorTool

type: TSharedPtr<FUI...


code: FSampleToolsEditorModeCommands()


description: IModuleInterfaceimplementation


className: FSampleToolsEditorModeModule

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


description: Returns the localized name of this toolkit type (typically just "editor")

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetBaseToolkitName() const


description: Returns the invariant name of this toolkit type

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


description: Initializes the mode toolkit

code: virtual void Init ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IToolkitHost](API\Editor\EditorFramework\Toolkits\IToolkitHost) > & InitToolkitHost, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UEdMode](API\Editor\UnrealEd\Tools\UEdMode) > InOwningMode )


description: Returns the number of Mode specific tabs in the mode toolbar

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


code: FSampleToolsEditorModeToolkit()


className: FSampleToolsEditorModeToolkit

description: ThisFModeToolkitjust creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.

code: class FSampleToolsEditorModeToolkit : public [FModeToolkit](API\Editor\UnrealEd\Toolkits\FModeToolkit)


code: static const FEditorModeID EM_SampleToolsEditorModeId = TEXT("EM_SampleToolsEditorMode");


code: virtual void CreateToolkit()


code: virtual void Enter()


code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > > > GetModeCommands() const


code: virtual ~USampleToolsEditorMode()


code: USampleToolsEditorMode()


className: USampleToolsEditorMode

description: This class provides an example of how to extend aUEdModeto add some simple tools using the InteractiveTools framework. The variousUEdModeinput event handlers (see UEdMode.h) forward events to aUEdModeInteractiveToolsContextinstance, which has all the logic for interacting with the InputRouter, ToolManager, etc. The functions provided here are the minimum to get started inserting some custom behavior. Take a look at theUEdModemarkup for more extensibility options.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class USampleToolsEditorMode : public [UEdMode](API\Editor\UnrealEd\Tools\UEdMode)


className: EScreenReaderAnnouncementPriority

description: The priority level associated with a screen reader announcement. The priority of an announcement could be used to determine if an announcement A could interrupt announcement B or to help order the announcements if multiple are queued.

module: ScreenReader

code: enum EScreenReaderAnnouncementPriority { High = 0, Medium, Low, }


description: FDefaultInterruptionPolicy

code: template<typename InterruptionPolicy> static bool CanBeInterruptedBy ( const [FScreenReaderAnnouncement](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncement) & Interruptee, const [FScreenReaderAnnouncement](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncement) & Interrupter, const InterruptionPolicy & InInterruptionPolicy )


description: Returns true if A is less than B

code: bool operator&40;&41; &40; const FScreenReaderAnnouncement & A, const FScreenReaderAnnouncement & B &41; const


className: FDefaultComparator

description: The default comparator for screen reader announcements. Can be used to order screen announcements in a priority queue Users can provide their own comaprators by implementing the same interface.

code: struct FDefaultComparator


description: Returns true if the interruptee can be interrupted by the interruptor. Else returns false

code: bool CanBeInterruptedBy &40; const FScreenReaderAnnouncement & Interruptee, const FScreenReaderAnnouncement & Interrupter &41; const


className: FDefaultInterruptionPolicy

description: The default interruption policy to determine if announcement A can be interrupted by announcement B. Users can provide their own implementation by creating their own struct and implementing the same interface.

code: struct FDefaultInterruptionPolicy


code: const [FScreenReaderAnnouncementInfo](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncementInfo) & GetAnnouncementInfo() const


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


description: Only used to satisfy USTRUCT requirements Please use ctor that takes arguments

code: FScreenReaderAnnouncement()


description: The constructor that should be used in most cases.

code: FScreenReaderAnnouncement ( [FString](API\Runtime\Core\Containers\FString) InAnnouncementString, [FScreenReaderAnnouncementInfo](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncementInfo) )


className: FScreenReaderAnnouncement

description: FScreenReaderUser

AnnouncementInfo

type: FScreenReaderAn...

description: The announcement info associated with the announcement which controls how the announcement behaves when a user requests this announcement to be spoken to an end user

AnnouncementString

description: A localized string that represents the message to be spoken to a end user


code: float GetSpeechVolume() const


description: Converts the contents of the announcement to a string for easy printing. Useful for debugging.


code: [FScreenReaderAnnouncementChannel](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncementChannel) & operator= ( const [FScreenReaderAnnouncementChannel](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncementChannel) & OtherAnnouncementChannel )


code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) RequestSpeakWidget ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & InWidget )


code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) SetSpeechRate ( float InRate )


code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) SetSpeechVolume ( float InVolume )


code: FScreenReaderAnnouncementChannel ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextToSpeechBase](API\Plugins\TextToSpeech\GenericPlatform\FTextToSpeechBase) > & InTextToSpeech )


code: FScreenReaderAnnouncementChannel ( const [FScreenReaderAnnouncementChannel](API\Plugins\ScreenReader\Announcement\FScreenReaderAnnouncementChannel) & OtherAnnouncementChannel )


className: FScreenReaderAnnouncementChannel

description: FScreenReaderAnnouncementInfo

code: class FScreenReaderAnnouncementChannel


description: The announcement info used for announcements concerning widgets and their content. These are the lowest priority, are interruptable and will not be queued if interrupted. Use this when requestin any announcements related to widgets that the user can easily access again E.g Useful for announcing widgets that the user is currently focused on. The user can always refocus on the widget to hear its contents spoken so it doesn't matter if it is interrupted.


description: An announcement info used for announcements that are of critical importance to the end user. Announcements with this announcement info have the highest priority, are not interruptable by other announcements and will be queued if multiple important announcements are requested. Use this for communicating critical information to an end user. E.g Use this for announcements concerning the system (battery low, accessibility enabled etc) or important in game events that cannot be revisted or played again.


code: bool IsInterruptable() const


description: Returns a string that represents all of the data reflected in this struct.


description: This announcement info is used for announcements to provide feedback for end user actions or inform them of changes. Announcements with this announcement info have medium priority, can be interrupted and will not be queued if interrupted by an announcement of equal or higher priority. User this announcement info for announcements that provide feedback to the end user. E.g When they have successfully activated a UI element, the screen has changed to display a different meny or when new elements have appeared on screen that the user should know about.


description: Only used to satisfy USTRUCT constraints Please use ctor that takes parameters

code: FScreenReaderAnnouncementInfo()


code: FScreenReaderAnnouncementInfo ( bool bInShouldQueue, bool bInInterruptable, [EScreenReaderAnnouncementPriority](API\Plugins\ScreenReader\Announcement\EScreenReaderAnnouncementPriorit-) InPriority )


className: FScreenReaderAnnouncementInfo

description: FScreenReaderAnnouncement


code: virtual bool BeginReshapingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void FinishedReshapingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [FWindowSizeLimits](API\Runtime\ApplicationCore\GenericPlatform\FWindowSizeLimits) GetSizeLimitsForWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window ) const


description: Returns the underlying message handler that application messages bubble down to if the screen reader application message handler does not handle the event.


code: virtual [EWindowZone::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowZone__Type) GetWindowZoneForPoint ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 X, const int32 Y )


code: virtual void HandleDPIScaleChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void OnBeginGesture()


code: virtual bool OnApplicationActivationChanged ( const bool IsActive )


description: Deprecate these when engine code has been converted to handle platform user id

code: virtual bool OnControllerAnalog ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, float AnalogValue )


code: virtual bool OnControllerAnalog ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, float AnalogValue )


description: Deprecated* This version of OnControllerButtonPressed is deprecated, please use the version that takes anFPlatformUserIdinstead

code: virtual bool OnControllerButtonPressed ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, bool IsRepeat )


code: virtual bool OnControllerButtonPressed ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, bool IsRepeat )


description: Deprecated* This version of OnControllerButtonReleased is deprecated, please use the version that takes anFPlatformUserIdinstead

code: virtual bool OnControllerButtonReleased ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, int32 ControllerId, bool IsRepeat )


code: virtual bool OnControllerButtonReleased ( [FGamepadKeyNames::Type](API\Runtime\ApplicationCore\GenericPlatform\FGamepadKeyNames\Type) KeyName, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) PlatformUserId, [FInputDeviceId](API\Runtime\Core\Misc\FInputDeviceId) InputDeviceId, bool IsRepeat )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragDrop ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterExternal ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [FString](API\Runtime\Core\Containers\FString) & Text, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Files )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterFiles ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Files )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragEnterText ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [FString](API\Runtime\Core\Containers\FString) & Text )


code: virtual void OnDragLeave ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual [EDropEffect::Type](API\Runtime\ApplicationCore\GenericPlatform\EDropEffect__Type) OnDragOver ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual bool OnKeyDown ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )


code: virtual bool OnKeyChar ( const TCHAR Character, const bool IsRepeat )


code: virtual bool OnKeyUp ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )


code: virtual bool OnMotionDetected ( const FVector & Tilt, const FVector & RotationRate, const FVector & Gravity, const FVector & Acceleration, int32 ControllerId )


code: virtual bool OnMouseDoubleClick ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseDoubleClick ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMouseDown ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMouseDown ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseUp ( const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button )


code: virtual bool OnMouseUp ( const [EMouseButtons::Type](API\Runtime\ApplicationCore\GenericPlatform\EMouseButtons__Type) Button, const FVector2D CursorPos )


code: virtual bool OnMouseWheel ( const float Delta )


code: virtual bool OnMouseWheel ( const float Delta, const FVector2D CursorPos )


code: virtual void OnOSPaint ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual void OnMovedWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 X, const int32 Y )


code: virtual bool OnRawMouseMove ( const int32 X, const int32 Y )


code: virtual void OnResizingWindow ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


code: virtual bool OnSizeChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const int32 Width, const int32 Height, bool bWasMinimized )


code: virtual bool OnTouchEnded ( const FVector2D & Location, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchFirstMove ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchForceChanged ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchGesture ( EGestureEvent GestureType, const FVector2D & Delta, float WheelDelta, bool bIsDirectionInvertedFromDevice )


code: virtual bool OnTouchMoved ( const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnTouchStarted ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const FVector2D & Location, float Force, int32 TouchIndex, int32 ControllerId )


code: virtual bool OnWindowAction ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const [EWindowAction::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowAction__Type) InActionType )


code: virtual bool OnWindowActivationChanged ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window, const EWindowActivation ActivationType )


code: virtual void OnWindowClose ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & Window )


description: Sets whether key inputs should be intercepted and processed. If set to false, the key inputs will ubble straight down to the target message handler.

code: void SetProcessKeyInput ( bool bInProcessKeyInput )


description: Sets whether mouse events should be intercepted and processed. If false, the mouse events will bubble straight down to the target message handler.

code: void SetProcessMouseInput ( bool bInProcessMouseInput )


description: Retursn true if the key inputs should be intercepted and processed. Else returns false.

code: bool ShouldProcessKeyInput() const


description: Returns true if mouse events should be processed. Else returns false.

code: bool ShouldProcessMouseInput() const


code: virtual void ShouldSimulateGesture ( EGestureEvent Gesture, bool bEnable )


description: TargetMessageHandler

code: virtual bool ShouldProcessUserInputMessages ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGenericWindow](API\Runtime\ApplicationCore\GenericPlatform\FGenericWindow) > & PlatformWindow ) const


code: FScreenReaderApplicationMessageHandlerBase ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) > & InTargetMessageHandler, [FScreenReaderBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderBase) & InOwningScreenReader )


description: The base class all screen reader application message handlers should derive from.Bydefault, this is just a proxy for the underlying target message handler. The screen reader application message handler will intercept all application messages and may perform processing on the events before consuming the event or passing it to the underlying target message handler. Child classes should override the virtual event handlers fromFGenericAccessibleMessageHandlerto perform input processing for thier needs. For example: A mobile screen reader application message handler can subclass this class and intercept touch inputs to perform gesture detection to provide alternative navigation schemes for users. A desktop screen reader application message handler can subclass this class and intercept mouse movement events to speak widgets that the user mouses over.

OwningScreenReader

type: FScreenReaderBa...

description: The screen reader that owns this screen reader application message handler.


description: OnActivated()

code: void Activate()


description: OnDeactivated()

code: void Deactivate()


description: Returns the weak pointer to the platform application. Use this to access the accessible message handler and or retrieve cursor information.


description:
Returns a screen reader user associated with the passed in Id if the Id is registered. Otherwise, a nullptr is returned.
The screen reader user associated with the Id if the user is registered. Else nullptr.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FScreenReaderUser](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderUser) > GetUser ( int32 InUserId ) const


description:
Returns the screen reader user associated with the passed in Id. An assertion will trigger if the User Id is not registered. It is up to the user to ensure that the Id is valid and mapped to a valid screen reader user.
The screen reader user associated with the passed in Id

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FScreenReaderUser](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderUser) > GetUserChecked ( int32 InUserId ) const


description: Returns true if the passed in user Id is already registered. Else returns false.

code: bool IsUserRegistered ( int32 InUserId ) const


description: Returns true if the screen reader is active. Else false.

code: bool IsActive() const


description: FSlateScreenReader

code: void OnAccessibleEventRaised ( const [FAccessibleEventArgs](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FAccessibleEventArgs) & Args )


description: Called at the start ofDeactivate(). Override this function in child classes to provide additional teardown such as unsubscribing from accessible events or providing feedback to alert the user that the screen reader is deactivated.

code: virtual void OnDeactivate()


description: Called at the end ofActivate(). Override this function in child classes to do additional set up such as subscribing to accessible events, binding handlers for focus events or providing feedback to users that the screen reader has been activated.

code: virtual void OnActivate()


code: [FScreenReaderBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderBase) & operator= ( const [FScreenReaderBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderBase) & Other )


description: Registers a provided user Id to the screen reader framework and allows the user to receive and respond to accessible events and accessible input. Does nothing if the passed in Id is already registered. @ return Returns true if the Id is successfully registered with the screen reader. Else returns false.

code: bool RegisterUser ( int32 InUserId )


code: void SetScreenReaderApplicationMessageHandler ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FScreenReaderApplicationMessageHandlerBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderApp-) > & InScreenReaderApplicationMessageHandler )


description: Unregisteres all screen reader users. No users can receive or respond to accessible events or accessible input upon calling this function.

code: void UnregisterAllUsers()


description:
Unregisters a provided user Id from the screen reader framework and deactivates the user. The unregistered user will no longer receive or respond to accessible events and input. Nothing will happen if the provided user Id has not been registered with the screen reader.
Returns true if the provided user Id has been successfully unregistered. Else returns false.

code: bool UnregisterUser ( int32 InUserId )


code: FScreenReaderBase ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [GenericApplication](API\Runtime\ApplicationCore\GenericPlatform\GenericApplication) > & InPlatformApplication )


description: We disallow copying.

code: FScreenReaderBase ( const [FScreenReaderBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderBase) & Other )


code: virtual ~FScreenReaderBase()


className: FScreenReaderBase

description: FScreenReaderUser

code: class FScreenReaderBase


code: FScreenReaderReply &40; bool bInHandled &41;


className: FScreenReaderReply

description: FScreenReaderUser


description: Activates the screen reader user and fulfill requests for accessibility services such as text to speech that clients can make. When screen reader users are firstr registered with a screen reader, they are deactivated by default. Users must explicitly activate the screen reader user.

code: void Activate()


description: Deactivates the screen reader and disables all announcement and text to speech services making them do nothing.

code: void Deactivate()


description: Returns the speech rate text to speech is speaking at for this user. Value will be between 0.0f and 1.0f.

code: float GetSpeechRate() const


description: Returns the speech volume for text to speech. Value will be between 0.0f and 1.0f.

code: float GetSpeechVolume() const


description: Returns true if the text to speech for this user is muted. Else returns false.

code: bool IsSpeechMuted() const


description: Returns true if an announcement is currently being spoken. Else returns false.

code: bool IsSpeaking() const


description: Mutes the text to speech for this user so requests to speak strings will be inaudible.FScreenReaderReply::Handled()if the text to speech is successfully muted. Else,FScreenReaderReply::Unhandled()is returned.


description: Shifts focus to the first ancestor of the user's currently focused accessible widget based on the current navigation policy.FScreenReaderReply::Handled()if focus has successfully shifted to the first ancestor of the currently focused accessible widget. Else returnsFScreenReaderReply::Unhandled()


description: Shifts focus to the first child from the user's currently focused accessible widget based on the current navigation policy. Focus is unaffected if the user's currently focused accessible widget has no children.FScreenReaderReply::Handled()if focus has successfully shifted to the first child from the currently focused accessible widget based on the navigation policy. Else returnsFScreenReaderReply::Unhandled()


description: Shifts focus to the next sibling from the user's currently focused accessible widget based on the current navigation policy.FScreenReaderReply::Handled()if focus has successfully shifted to a next sibling from the currently focused accessible widget. Else returnsFScreenReaderReply::Unhandled()


description: Shifts focus to the logical next widget in the accessible widget hierarchy from the user's currently focused accessible widget based on the current navigation policy. SeeIAccessibleWidget::GetNextWidgetInHierarchyfor an explanation of what the logical next widget in the accessible hierarchy means.FScreenReaderReply::Handled()if focus has successfully shifted to a next widget from the currently focused accessible widget. Else returnsFScreenReaderReply::Unhandled()


description: Shifts focus to the previous sibling from the user's currently focused accessible widget based on the current navigation policy.FScreenReaderReply::Handled()if focus has successfully shifted to a previous sibling from the currently focused accessible widget. Else returnsFScreenReaderReply::Unhandled()


description: Shifts focus to the logical previous widget in the accessible widget hierarchy from the user's currently focused accessible widget based on the current navigation policy. SeeIAccessibleWidget::GetPreviousWidgetInHierarchyfor an explanation of what the logical previous widget in the accessible hierarchy means.FScreenReaderReply::Handled()if focus has successfully shifted to a logical previous widget from the currently focused accessible widget. Else returnsFScreenReaderReply::Unhandled()


description: FGenericAccessibleUserRegistry

code: virtual void OnUnregistered()


description: Returns true if the screen reader user is active. Else returns false.

code: bool IsActive() const


description: FScreenReaderAnnouncementInfo


description: Requests the information about an accessibility widget to be read out to a user. The same guarantees about the announcement being spoken inRequestSpeak()apply for this function.FScreenReaderReply::Handled()if the widget's information is successfully spoken. Else returnsFScreenReaderReply::Unhandled();

code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) RequestSpeakWidget ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & InWidget )


description: Sets the navigation policy this screen reader user will be using. The screen reader navigation policy will affect all functionality to do with shifting focus to the next available widget.

code: void SetNavigationPolicy ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IScreenReaderNavigationPolicy](API\Plugins\ScreenReader\Navigation\IScreenReaderNavigationPolicy) > & InNavigationPolicy )


description: Sets the speech rate text to speech will speak at for this user. Passed in value is clamped between 0.0f and 1.0f.FScreenReaderReply::Handled()if the speech rate is successfully set. Else,FScreenReaderReply::Unhandled()is returned.

code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) SetSpeechRate ( float InRate )


description: Sets the speech volume for text to speech to speak at. The passed in value will be clamped between 0.0f and 1.0f.FScreenReaderReply::Handled()if the volume is successfully set. Else FScreenReader::Unhandled() is returned.

code: [FScreenReaderReply](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderReply) SetSpeechVolume ( float InVolume )


description:
Immediately stops speaking any currently spoken announcement. Does nothing if there is no announcement currently being spoken.
FScreenReader::Handled() if the request to stop speaking is successfully processed. Else returnsFScreenReaderReply::Unhandled()


description: Unmutes the text to speech for this user so that requests to speak strings will be audible again.FScreenReaderReply::Handled()if the text to speech si successfully unmuted. Else,FScreenReaderReply::Unhandled()is returned.


code: FScreenReaderUser ( FAccessibleUserIndex InUserIndex )


className: FScreenReaderUser

description: Accessible Navigation - Screen reader users have finer navigation controls around the accessible widget hierarchy as compared to regular tab navigation with keyboard or D-pad controls with a gamepad.

code: class FScreenReaderUser : public [FGenericAccessibleUser](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\FGenericAccessibleUser)


description:
A pure virtual function to build a screen reader. Users must override this class to provide logic for building their custom screen readers.
The constructed screen reader built from the passed in arguments

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FScreenReaderBase](API\Plugins\ScreenReader\GenericPlatform\FScreenReaderBase) > Create ( const [IScreenReaderBuilder::FArgs](API\Plugins\ScreenReader\GenericPlatform\IScreenReaderBuilder\FArgs) & InArgs )


code: FArgs &40; const TSharedRef< GenericApplication > & InPlatformApplication &41;


className: FArgs

description: The arguments to be passed to the screen reader to be built

code: struct FArgs

PlatformApplication

type: constTSharedRe...

description: The platform application to be passed to the screen reader for initialization.


code: virtual ~IScreenReaderBuilder()


className: IScreenReaderBuilder

description: The abstract interface for builders of all screen readers. Users should subclass and provide a concrete implementation for building their custom screen readers.

code: class IScreenReaderBuilder


code: bool operator&40;&41; &40; const TSharedRef< IAccessibleWidget > & InWidget &41; const


className: FScreenReaderDefaultNavigationPredicate


description: Returns the first ancestor from the source widget that satisfies the navigation policy.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetFirstAncestorFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


description: Returns the first child from the source widget that satisfies the navigation policy.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetFirstChildFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


description: Returns the first instance of a next sibling from the source widget that satisfies the navigation policy.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetNextSiblingFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


description: Returns the first instance of a previous sibling from the source widget that satisfies the navigation policy.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetPreviousSiblingFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


description: IAccessibleWidget

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetPreviousWidgetInHierarchyFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


className: FScreenReaderDefaultNavigationPolicy

code: class FScreenReaderDefaultNavigationPolicy : public [IScreenReaderNavigationPolicy](API\Plugins\ScreenReader\Navigation\IScreenReaderNavigationPolicy)


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetFirstAncestorFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > GetFirstChildFrom ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IAccessibleWidget](API\Runtime\ApplicationCore\GenericPlatform\Accessibility\IAccessibleWidget) > & Source ) const