description: Enumerates supported raw image formats. should map one-to-one with ETextureSourceFormat

code: namespace ERawImageFormat { enum Type { G8, BGRA8, BGRE8, RGBA16, RGBA16F, RGBA32F, G16, R16F, R32F, Invalid = 0xFF, } }


module: ImageCore

code: namespace ERawImageFormat { bool ERawImageFormat::IsHDR ( [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


description: For 8-bit UNorm formats, both RGBA and BGRA channel order variants exist and are popular. This function does the trivial conversion between the two, updating both the DXGI Format and the pixel data to do so. When the channel order is already correct or the pixel format is not one of the few formats that exist in both RGBA and BGRA variants, this function does nothing.

code: void ConvertChannelOrder ( [EChannelOrder](API\Runtime\ImageCore\UE__DDS__EChannelOrder) InTargetOrder )


description: G8 and BGRA8 are affected by Gamma 16/32 is NOT

code: namespace ERawImageFormat { bool ERawImageFormat::GetFormatNeedsGammaSpace ( [Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


description: Convert X alpha to A and fill 255

code: void ConvertRGBXtoRGBA()


description: On error, returns nullptr. If a non-null OutError is supplied, error information is written there.

code: static [FDDSFile](API\Runtime\ImageCore\FDDSFile) * CreateEmpty ( int32 InDimension, uint32 InWidth, uint32 InHeight, uint32 InDepth, uint32 InMipCount, uint32 InArraySize, [EDXGIFormat](API\Runtime\ImageCore\UE__DDS__EDXGIFormat) InFormat, uint32 InCreateFlags, [EDDSError](API\Runtime\ImageCore\UE__DDS__EDDSError) * OutError )


description: Convenience version of the above to create a basic 2D texture with mip chain.

code: static [FDDSFile](API\Runtime\ImageCore\FDDSFile) * CreateEmpty2D ( uint32 InWidth, uint32 InHeight, uint32 InMipCount, [EDXGIFormat](API\Runtime\ImageCore\UE__DDS__EDXGIFormat) InFormat, uint32 InCreateFlags, [EDDSError](API\Runtime\ImageCore\UE__DDS__EDDSError) * OutError )


code: static [FDDSFile](API\Runtime\ImageCore\FDDSFile) * CreateFromDDSInMemory ( const uint8 * InDDS, int64 InDDSSize, [EDDSError](API\Runtime\ImageCore\UE__DDS__EDDSError) * OutError, bool bHeaderOnly )


code: static constexpr uint32 CREATE_FLAG_CUBEMAP = 1;


description: Bit flags.

code: static constexpr uint32 CREATE_FLAG_NONE = 0;


code: static constexpr uint32 CREATE_FLAG_NO_MIP_STORAGE_ALLOC = 2;


code: static constexpr uint32 CREATE_FLAG_WAS_D3D9 = 4;


description: Fill DDS mip from ImageImage must be of format DXGIFormatFromRawFormat

code: void FillMip ( const [FImageView](API\Runtime\ImageCore\FImageView) & FromImage, int MipIndex )


description: Blit pixels from DDS mip to Image return false if no pixel format conversion is supported ToImage is not allocated, must be pre-allocated and sized correctly

code: bool GetMipImage ( const [FImageView](API\Runtime\ImageCore\FImageView) & ToImage, int MipIndex ) const


description: Is this buffer a DDS ?

code: static bool IsADDS ( const uint8 * InDDS, int64 InDDSSize )


description: Check if this DDS is usable in Unreal Texture types:

code: bool IsValidTexture2D() const


code: bool IsValidTextureArray() const


code: bool IsValidTextureCube() const


code: bool IsValidTextureVolume() const


description: 20 mips means 512k x 512k pixels max, should be sufficient for now. It's 512k not 1M because the final 1x1 pixel mip counts; i.e. a mip chain from 1048576x1048576 down to 1x1 has 21 mips!

code: static constexpr uint32 MAX_MIPS_SUPPORTED = 20;


description: Sanity-check that all members make sense and return an error code.


description: The latter is somewhat arbitrary. D3D9 DDS files don't store whether pixels for a texture are meant to be interpreted as sRGB or not. This reader treats the resulting formats as non-sRGB UNORM, so the writer does the same for symmetry.

code: [EDDSError](API\Runtime\ImageCore\UE__DDS__EDDSError) WriteDDS ( TArray64< uint8 > & OutDDS, [EDDSFormatVersion](API\Runtime\ImageCore\UE__DDS__EDDSFormatVersion) InFormatVersion )


className: FDDSFile

description: Ar->Close()delete Ar; }

code: struct FDDSFile

ArraySize

description: Array size here uses the conventions as in the D3D runtime, which means an array of N cubemaps has an array size of 6N (one element per face).

DXGIFormat

type: EDXGIFormat

MipRawData

type: TArray64< uint8...

description: When we allocate the mips ourselves, we keep all storage together in a single allocation, namely this one, and the mips point into it.

Mips

type: TArray<FDDSMip...

description: Mips are ordered starting from mip 0 (full-size texture) decreasing in size; for arrays, we store the full mip chain for one array element before advancing to the next array element, and have (ArraySize * MipCount) mips total.


className: FDDSMip

description: One of these for each mip of a DDS.

code: struct FDDSMip

Data

type: uint8 *

RowStride

description: Note: pixels in DDS data must be densely packed, they exist for ease of addressing but you can't represent strided data in this form.


code: TArrayView64< [FColor](API\Runtime\Core\Math\FColor) > AsBGRA8()


code: TArrayView64< const [FColor](API\Runtime\Core\Math\FColor) > AsBGRA8() const


code: TArrayView64< [FColor](API\Runtime\Core\Math\FColor) > AsBGRE8()


code: TArrayView64< const [FColor](API\Runtime\Core\Math\FColor) > AsBGRE8() const


code: TArrayView64< const uint16 > AsG16() const


code: TArrayView64< const uint8 > AsG8() const


code: TArrayView64< [FFloat16](API\Runtime\Core\Math\FFloat16) > AsR16F()


code: TArrayView64< const [FFloat16](API\Runtime\Core\Math\FFloat16) > AsR16F() const


code: TArrayView64< const float > AsR32F() const


code: TArrayView64< uint16 > AsRGBA16()


code: TArrayView64< const uint16 > AsRGBA16() const


code: TArrayView64< [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) > AsRGBA16F()


code: TArrayView64< const [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) > AsRGBA16F() const


code: TArrayView64< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > AsRGBA32F()


code: TArrayView64< const [FLinearColor](API\Runtime\Core\Math\FLinearColor) > AsRGBA32F() const


description: In-place format change : does nothing if already in the desired format

code: void ChangeFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) DestFormat, EGammaSpace DestGammaSpace )


description: Copies the image to a destination image with the specified format.

code: void CopyTo ( [FImage](API\Runtime\ImageCore\FImage) & DestImage, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) DestFormat, EGammaSpace DestGammaSpace ) const


description: CopyTo same format.

code: void CopyTo ( [FImage](API\Runtime\ImageCore\FImage) & DestImage ) const


description: Get one pixel from the image and return in Linear color.

code: const [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetOnePixelLinear ( int32 X, int32 Y, int32 Slice ) const


description: Get a pointer to a pixel

code: void * GetPixelPointer ( int32 X, int32 Y, int32 Slice ) const


code: void Init ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat )


description: Get anFImageViewto one 2d slice

code: [FImageView](API\Runtime\ImageCore\FImageView) GetSlice ( int32 SliceIndex ) const


code: void Init ( int32 InSizeX, int32 InSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat )


description: Initializes this image with a single slice. Allocates RawData.

code: void Init ( int32 InSizeX, int32 InSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


description: Initializes this image with the specified number of slices. Allocates RawData.

code: void Init ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


code: void Linearize ( [FImage](API\Runtime\ImageCore\FImage) & DestImage ) const


description: SourceEncoding = None (0) to Linearize using the GammaSpace in thisFImage

code: void Linearize ( uint8 SourceEncoding, [FImage](API\Runtime\ImageCore\FImage) & DestImage ) const


className: FImage::operator FImageView

description: Implicit conversion toFImageViewallowsFImageto be passed to functions that takeFImageViewfunctions that read images should use "const FImageView &" as their argument type

code: operator FImageView() const


description: Copies and resizes the image to a destination image with the specified size and format. Resize is done using bilinear filtering

code: void ResizeTo ( [FImage](API\Runtime\ImageCore\FImage) & DestImage, int32 DestSizeX, int32 DestSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) DestFormat, EGammaSpace DestGammaSpace ) const


description: Swap the contents of thisFImagewith another.

code: void Swap ( [FImage](API\Runtime\ImageCore\FImage) & Other )


description: Deprecated* TransformToWorkingColorSpace is deprecated, please use the function in FImageCore.

code: void TransformToWorkingColorSpace ( const FVector2d & SourceRedChromaticity, const FVector2d & SourceGreenChromaticity, const FVector2d & SourceBlueChromaticity, const FVector2d & SourceWhiteChromaticity, [UE::Color::EChromaticAdaptationMethod](API\Runtime\ColorManagement\UE__Color__EChromaticAdaptationM-) Method, double EqualityTolerance )


description: Default constructor.

code: FImage()


description: Initializes this image with specified Info. Allocates RawData.

code: void Init ( const [FImageInfo](API\Runtime\ImageCore\FImageInfo) & Info )


description: Note: changed default GammaSpace from Linear to GetDefaultGammaSpace

code: FImage ( int32 InSizeX, int32 InSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat )


description: Creates and initializes a new image with a single slice.

code: FImage ( int32 InSizeX, int32 InSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


description: Creates and initializes a new image with the specified number of slices.

code: FImage ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


code: FImage ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat )


className: FImage

description: Structure for raw image data.

code: struct FImage : public [FImageInfo](API\Runtime\ImageCore\FImageInfo)

RawData

description: Raw image data.


description: ETextureSourceFormat andERawImageFormat::Typeare one-to-one :

code: namespace FImageCoreUtils { [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) FImageCoreUtils::ConvertToRawImageFormat ( ETextureSourceFormat Format ) }


code: namespace FImageCoreUtils { ETextureSourceFormat FImageCoreUtils::ConvertToTextureSourceFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


code: namespace FImageCoreUtils { [FName](API\Runtime\Core\UObject\FName) FImageCoreUtils::ConvertToUncompressedTextureFormatName ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) Format ) }


description: Returns ETextureSourceFormat which can be used to efficiently store data encoded in both input formats. Can be used in cases when multiple sources need to be mixed together (i.e. in a texture array or UDIM)

code: namespace FImageCoreUtils { ETextureSourceFormat FImageCoreUtils::GetCommonSourceFormat ( ETextureSourceFormat Format1, ETextureSourceFormat Format2 ) }


description: Returns the number of mips that constitute a full mip chain for the given top level mip size. InVolumeZ is ignored unless bInIsVolume is true

code: namespace FImageCoreUtils { int32 FImageCoreUtils::GetMipCountFromDimensions ( int32 InSizeX, int32 InSizeY, int32 InVolumeZ, bool bInIsVolume ) }


description: EPixelFormat is the graphics texture pixel format it is a much larger superset of ERawImageFormat GetPixelFormatForRawImageFormat does not map to the very closest EPixelFormat instead map to a close one that is actually usable as Texture if *pOutEquivalentFormat != InFormat , then conversion is needed and conversion can be done using CopyImage to OutEquivalentFormat

code: namespace FImageCoreUtils { EPixelFormat FImageCoreUtils::GetPixelFormatForRawImageFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) * pOutEquivalentFormat ) }


description: Compute the min/max of each channel to get value ranges Colors are converted to float Linear Gamma

code: namespace FImageCore { void FImageCore::ComputeChannelLinearMinMax ( const [FImageView](API\Runtime\ImageCore\FImageView) & InImage, [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutMin, [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutMax ) }


description: IsImageImportPossible returns false if the image dimensions are not supported to import if this function returns true, image import might still fail due to further constraints (this constraint is weaker than the one actually required) (see IsImportResolutionValid, which is also still weaker than the final constraint) IsImageImportPossible does not check current Engine config or platform limits, only hard-coded absolute limits

code: namespace FImageCoreUtils { bool FImageCoreUtils::IsImageImportPossible ( int64 Width, int64 Height ) }


description: ComputeImageLinearAverage compute the average linear color of the image image can be any pixel format parallel processing is used, but the result is not machine-dependent

code: namespace FImageCore { [FLinearColor](API\Runtime\Core\Math\FLinearColor) FImageCore::ComputeImageLinearAverage ( const [FImageView](API\Runtime\ImageCore\FImageView) & Image ) }


description: Copies an image accounting for format differences. Sizes must match.

code: namespace FImageCore { void FImageCore::CopyImage ( const [FImageView](API\Runtime\ImageCore\FImageView) & SrcImage, const [FImageView](API\Runtime\ImageCore\FImageView) & DestImage ) }


description: Copy Image to 2xU16 ; Dest Image should be allocated as BGRA8 but is actually 2xU16 Sizes must match. Dest must already be allocated.

code: namespace FImageCore { void FImageCore::CopyImageTo2U16 ( const [FImageView](API\Runtime\ImageCore\FImageView) & SrcImage, const [FImageView](API\Runtime\ImageCore\FImageView) & DestImage ) }


description: Copy Image, swapping RB, SrcImage must be BGRA8 or RGBA16. Sizes must match. Dest must already be allocated. Src == Dest is okay for in-place transpose.

code: namespace FImageCore { void FImageCore::CopyImageRGBABGRA ( const [FImageView](API\Runtime\ImageCore\FImageView) & SrcImage, const [FImageView](API\Runtime\ImageCore\FImageView) & DestImage ) }


description: Lambda is a functor that works on anFImageView()it will be called with portions of the image each portion will be a 2dFImageView(NumSlices == 1) use like :FImageCore::ImageParallelFor( TEXT("Texture.AdjustImageColorsFunc.PF"),Image,&{

code: namespace FImageCore { template<typename Lambda> void FImageCore::ImageParallelFor ( const TCHAR * DebugName, const [FImageView](API\Runtime\ImageCore\FImageView) & Image, const Lambda & Func ) }


description:
Detects whether or not the image contains an alpha channel where at least one texel is != 255.
True if the image both supports and uses the alpha channel. False otherwise.

code: namespace FImageCore { bool FImageCore::DetectAlphaChannel ( const [FImageView](API\Runtime\ImageCore\FImageView) & InImage ) }


description: FImageis tight packed in memory with slices adjacent to each other so we can just treat it was a 2d image with Height *= NumSlices

code: namespace FImageCore { int32 FImageCore::ImageParallelForComputeNumJobs ( const [FImageView](API\Runtime\ImageCore\FImageView) & Image, int64 * pRowsPerJob ) }


code: namespace FImageCore { void FImageCore::ImageParallelForMakePart ( [FImageView](API\Runtime\ImageCore\FImageView) * Part, const [FImageView](API\Runtime\ImageCore\FImageView) & Whole, int64 JobIndex, int64 RowsPerJob ) }


description: Parallel process image as TArrayView64your lambda is called on one row at a time so that the grouping is machine invariant

code: namespace FImageCore { template<typename Lambda> void FImageCore::ImageParallelProcessLinearPixels ( const TCHAR * DebugName, const [FImageView](API\Runtime\ImageCore\FImageView) & Image, const Lambda & Func ) }


description: ProcessLinearPixels act on image pixels as TArrayView64Colors pass a lambda that is : ProcessLinearPixelsAction ProcessPixels(TArrayView64Colors) returnProcessLinearPixelsAction::Modifiedif you modify colors returnProcessLinearPixelsAction::ReadOnlyif you only read and don't change colors your lambda will be called on one row at a time

code: namespace FImageCore { template<typename Lambda> void FImageCore::ProcessLinearPixels ( const [FImageView](API\Runtime\ImageCore\FImageView) & Image, const Lambda & Func ) }


description: You can use this for read (returnProcessLinearPixelsAction::ReadOnly) or read-write (returnProcessLinearPixelsAction::Modified).ImageCore.h in global namespace: ImageParallelForComputeNumJobsForPixels ImageParallelForComputeNumJobsForRows

code: namespace FImageCore { enum ProcessLinearPixelsAction { ReadOnly, Modified, } }


description: Copies and resizes the image to a destination image with the specified size and format. Resize is done using bilinear filtering

code: namespace FImageCore { void FImageCore::ResizeTo ( const [FImageView](API\Runtime\ImageCore\FImageView) & SourceImage, [FImage](API\Runtime\ImageCore\FImage) & DestImage, int32 DestSizeX, int32 DestSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) DestFormat, EGammaSpace DestGammaSpace ) }


description: Change alpha channel to opaque, if present

code: namespace FImageCore { void FImageCore::SetAlphaOpaque ( const [FImageView](API\Runtime\ImageCore\FImageView) & InImage ) }


description: Apply a color space transformation from the source chromaticities to the engine's working color space.

code: namespace FImageCore { void FImageCore::TransformToWorkingColorSpace ( const [FImageView](API\Runtime\ImageCore\FImageView) & InLinearImage, const FVector2d & SourceRedChromaticity, const FVector2d & SourceGreenChromaticity, const FVector2d & SourceBlueChromaticity, const FVector2d & SourceWhiteChromaticity, [UE::Color::EChromaticAdaptationMethod](API\Runtime\ColorManagement\UE__Color__EChromaticAdaptationM-) Method, double EqualityTolerance ) }


description: Clamp Float16 colors which aren't encodable in the BC6H format RGB is clamped to non-negative and finite A is set to 1.0

code: namespace FImageCore { void FImageCore::SanitizeFloat16AndSetAlphaOpaqueForBC6H ( const [FImageView](API\Runtime\ImageCore\FImageView) & InOutImage ) }


description:
Gets the number of bytes per pixel.
Bytes per pixel.

code: int64 GetBytesPerPixel() const


description: Swap RB channels on Image. Image must be BGRA8 or RGBA16.

code: namespace FImageCore { void FImageCore::TransposeImageRGBABGRA ( const [FImageView](API\Runtime\ImageCore\FImageView) & Image ) }


code: EGammaSpace GetGammaSpace() const


code: int64 GetImageSizeBytes() const


description: Get offset of a pixel from the base pointer, in bytes

code: int64 GetPixelOffsetBytes ( int32 X, int32 Y, int32 Slice ) const


code: int64 GetSliceNumPixels() const


code: int64 GetSliceSizeBytes() const


code: bool operator== ( const [FImageInfo](API\Runtime\ImageCore\FImageInfo) & rhs ) const


code: FImageInfo ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


className: FImageInfo

description: FImageInfodescribes a 2d pixel surface it can be used byFImageorFImageView

code: struct FImageInfo

Format

type: ERawImageFormat...

description: Format in which the image is stored.

GammaSpace

type: EGammaSpace

description: The gamma space the image is stored in.

NumSlices

description: Number of image slices.

SizeX

description: Width of the image.

SizeY

description: Height of the image.


code: TArrayView64< [FColor](API\Runtime\Core\Math\FColor) > AsBGRA8() const


code: TArrayView64< [FColor](API\Runtime\Core\Math\FColor) > AsBGRE8() const


code: TArrayView64< uint16 > AsG16() const


description: Convenience accessors to raw data these are const member functions because theFImageViewobject itself is const, but the image it points to may not be

code: TArrayView64< uint8 > AsG8() const


code: TArrayView64< [FFloat16](API\Runtime\Core\Math\FFloat16) > AsR16F() const


code: TArrayView64< float > AsR32F() const


code: TArrayView64< uint16 > AsRGBA16() const


code: TArrayView64< [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) > AsRGBA16F() const


code: TArrayView64< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > AsRGBA32F() const


description: CopyTo same format.

code: void CopyTo ( [FImage](API\Runtime\ImageCore\FImage) & DestImage ) const


description: Copies the image to a destination image with the specified format.

code: void CopyTo ( [FImage](API\Runtime\ImageCore\FImage) & DestImage, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) DestFormat, EGammaSpace DestGammaSpace ) const


description: Get one pixel from the image and return in Linear color.

code: const [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetOnePixelLinear ( int32 X, int32 Y, int32 Slice ) const


description: Get a pointer to a pixel

code: void * GetPixelPointer ( int32 X, int32 Y, int32 Slice ) const


description: Get anFImageViewto one 2d slice

code: [FImageView](API\Runtime\ImageCore\FImageView) GetSlice ( int32 SliceIndex ) const


code: FImageView ( const [FImageInfo](API\Runtime\ImageCore\FImageInfo) & InInfo, void * InRawData )


description: Make anFImageViewfrom an array ofFLinearColorpixels as RGBA32F.

code: FImageView ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) * InColors, int32 InSizeX, int32 InSizeY )


description: Make anFImageViewfrom an array ofFLinearColorpixels as RGBA16F.

code: FImageView ( const [FFloat16Color](API\Runtime\Core\Math\FFloat16Color) * InColors, int32 InSizeX, int32 InSizeY )


description: Make anFImageViewfrom an array ofFColorpixels as BGRA8.

code: FImageView ( const [FColor](API\Runtime\Core\Math\FColor) * InColors, int32 InSizeX, int32 InSizeY, EGammaSpace InGammaSpace )


code: FImageView ( void * InData, int32 InSizeX, int32 InSizeY, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat )


code: FImageView ( void * InData, int32 InSizeX, int32 InSizeY, int32 InNumSlices, [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat, EGammaSpace InGammaSpace )


className: FImageView

code: struct FImageView : public [FImageInfo](API\Runtime\ImageCore\FImageInfo)

RawData

type: void *


description: Channel ordering for 8-bit formats.

code: namespace UE { namespace DDS { enum EChannelOrder { RGBA, BGRA, } } }


description: Error codes.

code: namespace UE { namespace DDS { enum EDDSError { OK, Ok = OK, OutOfMemory, NotADds, NotADDS = NotADds, BadResourceDimension, BadPixelFormat, BadImageDimension, BadMipmapCount, BadCubemap, IoError, } } }


description: What version of DDS file to write.

code: namespace UE { namespace DDS { enum EDDSFormatVersion { Auto, D3D9, D3D10, } } }


description: Complete list of formats.

code: namespace UE { namespace DDS { enum EDXGIFormat { RGBFMT, BCNFMT, ODDFMT, UNKNOWN = 0, R32G32B32A32_TYPELESS = 1, R32G32B32A32_FLOAT = 2, R32G32B32A32_UINT = 3, R32G32B32A32_SINT = 4, R32G32B32_TYPELESS = 5, R32G32B32_FLOAT = 6, R32G32B32_UINT = 7, R32G32B32_SINT = 8, R16G16B16A16_TYPELESS = 9, R16G16B16A16_FLOAT = 10, R16G16B16A16_UNORM = 11, R16G16B16A16_UINT = 12, R16G16B16A16_SNORM = 13, R16G16B16A16_SINT = 14, R32G32_TYPELESS = 15, R32G32_FLOAT = 16, R32G32_UINT = 17, R32G32_SINT = 18, R32G8X24_TYPELESS = 19, D32_FLOAT_S8X24_UINT = 20, R32_FLOAT_X8X24_TYPELESS = 21, X32_TYPELESS_G8X24_UINT = 22, R10G10B10A2_TYPELESS = 23, R10G10B10A2_UNORM = 24, R10G10B10A2_UINT = 25, R11G11B10_FLOAT = 26, R8G8B8A8_TYPELESS = 27, R8G8B8A8_UNORM = 28, R8G8B8A8_UNORM_SRGB = 29, R8G8B8A8_UINT = 30, R8G8B8A8_SNORM = 31, R8G8B8A8_SINT = 32, R16G16_TYPELESS = 33, R16G16_FLOAT = 34, R16G16_UNORM = 35, R16G16_UINT = 36, R16G16_SNORM = 37, R16G16_SINT = 38, R32_TYPELESS = 39, D32_FLOAT = 40, R32_FLOAT = 41, R32_UINT = 42, R32_SINT = 43, R24G8_TYPELESS = 44, D24_UNORM_S8_UINT = 45, R24_UNORM_X8_TYPELESS = 46, X24_TYPELESS_G8_UINT = 47, R8G8_TYPELESS = 48, R8G8_UNORM = 49, R8G8_UINT = 50, R8G8_SNORM = 51, R8G8_SINT = 52, R16_TYPELESS = 53, R16_FLOAT = 54, D16_UNORM = 55, R16_UNORM = 56, R16_UINT = 57, R16_SNORM = 58, R16_SINT = 59, R8_TYPELESS = 60, R8_UNORM = 61, R8_UINT = 62, R8_SNORM = 63, R8_SINT = 64, A8_UNORM = 65, R1_UNORM = 66, R9G9B9E5_SHAREDEXP = 67, R8G8_B8G8_UNORM = 68, G8R8_G8B8_UNORM = 69, BC1_TYPELESS = 70, BC1_UNORM = 71, BC1_UNORM_SRGB = 72, BC2_TYPELESS = 73, BC2_UNORM = 74, BC2_UNORM_SRGB = 75, BC3_TYPELESS = 76, BC3_UNORM = 77, BC3_UNORM_SRGB = 78, BC4_TYPELESS = 79, BC4_UNORM = 80, BC4_SNORM = 81, BC5_TYPELESS = 82, BC5_UNORM = 83, BC5_SNORM = 84, B5G6R5_UNORM = 85, B5G5R5A1_UNORM = 86, B8G8R8A8_UNORM = 87, B8G8R8X8_UNORM = 88, R10G10B10_XR_BIAS_A2_UNORM = 89, B8G8R8A8_TYPELESS = 90, B8G8R8A8_UNORM_SRGB = 91, B8G8R8X8_TYPELESS = 92, B8G8R8X8_UNORM_SRGB = 93, BC6H_TYPELESS = 94, BC6H_UF16 = 95, BC6H_SF16 = 96, BC7_TYPELESS = 97, BC7_UNORM = 98, BC7_UNORM_SRGB = 99, AYUV = 100, Y410 = 101, Y416 = 102, NV12 = 103, P010 = 104, P016 = 105, _420_OPAQUE = 106, YUY2 = 107, Y210 = 108, Y216 = 109, NV11 = 110, AI44 = 111, IA44 = 112, P8 = 113, A8P8 = 114, B4G4R4A4_UNORM = 115, P208 = 130, V208 = 131, V408 = 132, B8G8R8 = 1001, R8G8B8 = 1002, R8G8B8X8 = 1003, } } }


className: FBitmapFileHeader

description: .BMP file header.

module: ImageWrapper

code: struct FBitmapFileHeader


className: FBitmapInfoHeader

description: .BMP subheader.

code: struct FBitmapInfoHeader


description: .BMP subheader V4

code: struct FBitmapInfoHeaderV4


className: FBmiColorsMask

description: Used by InfoHeaders pre-version 4, a structure that is declared after theFBitmapInfoHeader.

code: struct FBmiColorsMask

RGBAMask

description: RGBA, in header pre-version 4, Alpha was only used as padding.


description: CanSetRawFormat returns true if SetRaw will accept this format

code: virtual bool CanSetRawFormat ( const ERGBFormat InFormat, const int32 InBitDepth ) const


description:
Beware several of the old wrappers (BMP,TGA) incorrectly used to return bits percolornot per channel they now correctly return per-channel.
The bit depth per-channel of the image.

code: virtual int32 GetBitDepth() const


description:
Gets the compressed data. (call SetRaw first) (Note: It may consume the data set in the SetCompressed function if it was set before)
Array of the compressed data. returns empty array on failure

code: virtual TArray64< uint8 > GetCompressed ( int32 Quality )


description: GetErrorMessage : nice idea, but not virtual, never called by the standard import path.

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


description:
Gets the format of the image. Theoretically, this is the format it would be best to callGetRaw()with, if you support it.
The format the image data is in

code: virtual ERGBFormat GetFormat() const


description: GetWidth

code: virtual int64 GetHeight() const


description: this is often broken, should only be used with InFormat ==GetFormat()DEPRECATED , useGetRaw()with 1 argument orGetRawImage()true on success, false otherwise.

code: virtual bool GetRaw ( const ERGBFormat InFormat, int32 InBitDepth, TArray64< uint8 > & OutRawData )


description: Returns InFormat if supported, else maps to something supported the returned format will passCanSetRawFormat()

code: virtual [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) GetSupportedRawFormat ( const [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat ) const


description: GetHeight

code: virtual int64 GetWidth() const


description:
after SetCompressed, image info queries like GetWidth and GetBitDepth are allowed call GetRaw to get the decoded bits decompression is not done until GetRaw
true if data was the expected format.

code: virtual bool SetCompressed ( const void * InCompressedData, int64 InCompressedSize )


description: Todo we should have this for all image wrapper.

code: bool SetCompressedFromView ( TArrayView64< const uint8 > Data )


description:
you must notSetRaw()with a format unless it passesCanSetRawFormat()deprecated : avoid direct calls toSetRaw(), use ImageWrapperModule CompressImage instead do not use InBytesPerRow, it is ignored SetRaw does not take gamma information assumes U8 = SRGB and all else = Linear
true if data was the expected format.

code: virtual bool SetRaw ( const void * InRawData, int64 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth, const int32 InBytesPerRow )


className: FHdrImageWrapper

description: http://radsite.lbl.gov/radiance/refer/Notes/picture_format.htmlhttp://paulbourke.net/dataformats/pic/To load the HDR file image format. Does not support all possible types HDR formats (e.g. xyze is not supported)

code: class FHdrImageWrapper : public [IImageWrapper](API\Runtime\ImageWrapper\IImageWrapper)


className: FTGAFileHeader

code: struct FTGAFileHeader


code: bool CanSetRawFormat ( const ERGBFormat InFormat, const int32 InBitDepth ) const


description: External users call these from ImageWrapperModule.h , see documentation there

code: static void ConvertRawImageFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) RawFormat, ERGBFormat & OutFormat, int & OutBitDepth )


code: int32 GetBitDepth() const


code: static [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) ConvertRGBFormat ( ERGBFormat RGBFormat, int BitDepth, bool * bIsExactMatch )


description: Get the current image format, mapped to an ERawImageFormat if ! *bIsExactMatch , conversion is needed can call afterSetCompressed()

code: [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) GetClosestRawImageFormat ( bool * bIsExactMatch ) const


code: TArray64< uint8 > GetCompressed ( int32 Quality )


code: ERGBFormat GetFormat() const


description: GetWidth

code: int64 GetHeight() const


code: bool GetRaw ( const ERGBFormat InFormat, int32 InBitDepth, TArray64< uint8 > & OutRawData )


description: This GetRaw call replaces the variants with format/depth arguments, but prefer GetRawImage instead.

code: bool GetRaw ( TArray64< uint8 > & OutRawData )


code: bool GetRaw ( const ERGBFormat InFormat, int32 InBitDepth, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutRawData )


code: bool GetRaw ( const ERGBFormat InFormat, int32 InBitDepth, TArrayView64< uint8 > OutRawData )


description: This is the recommended API to get the raw image data from the imagewrapper. Prefer this instead of any of theGetRaw()calls.

code: bool GetRawImage ( [FImage](API\Runtime\ImageCore\FImage) & OutImage )


description: note: ImageWrapper Format does not track if pixels are Gamma/SRGB or not assume they areERawImageFormat::GetDefaultGammaSpacegammaspace eg. U8 is SRGB and everything else is Linear

code: bool GetSRGB() const


code: static int64 GetRGBFormatBytesPerPel ( ERGBFormat RGBFormat, int BitDepth )


description: GetHeight

code: int64 GetWidth() const


code: [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) GetSupportedRawFormat ( const [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) InFormat ) const


code: bool SetCompressed ( const void * InCompressedData, int64 InCompressedSize )


description: Set the debug image name

code: void SetDebugImageName ( const TCHAR * InDebugImageName )


code: bool SetRaw ( const void * InRawData, int64 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth, const int32 InBytesPerRow )


description: Virtual destructor.

code: virtual ~IImageWrapper()


description: Convert an ImageWrapper style {ERGBFormat+BitDepth} into an ERawImageFormat forFImagereturnsERawImageFormat::Invalidif no mapping is possible bIsExactMatch is filled with whether the formats are an exact match or not if not, conversion is needed

code: [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) ConvertRGBFormat ( ERGBFormat Format, int BitDepth, bool * bIsExactMatch )


className: IImageWrapper

description: in general, direct use of theIImageWrapperinterface is now discouraged use ImageWrapperModule CompressImage/DecompressImage instead.

code: class IImageWrapper

DebugImageName

type: const TCHAR ...

description: Debug image name string for any errors or warnings


description: Convert anFImageERawImageFormat into an ImageWrapper style {ERGBFormat+BitDepth} mapping is always possible and requires no conversion

code: void ConvertRawImageFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) RawFormat, ERGBFormat & OutFormat, int & OutBitDepth )


description: Convert inputFImageinto a file-format encoded array. in ImageWrapper land, "Compress" means "put in file format" OutData is filled with the file format encoded data lossy conversion of the pixel type may be done if necessary eg. if you pass F32 float pixels to write to BMP, they will be converted to SRGB U8 BGRA8

code: bool CompressImage ( TArray64< uint8 > & OutData, EImageFormat ToFormat, const [FImageView](API\Runtime\ImageCore\FImageView) & InImage, int32 Quality )


description: Read an image from file format encoded data. ImageWrapper calls this a "decompress" OutImage is allocated and filled, any existing contents are discarded

code: bool DecompressImage ( const void * InCompressedData, int64 InCompressedSize, [FImage](API\Runtime\ImageCore\FImage) & OutImage )


description:
Create anIImageWrapperhelper of a specific type
The helper base class to manage the data EImageFormat is a compressor / file format, not a pixel format Deprecated. Prefer CompressImage/DecompressImage.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IImageWrapper](API\Runtime\ImageWrapper\IImageWrapper) > CreateImageWrapper ( const EImageFormat InFormat, const TCHAR * InOptionalDebugImageName )


description:
Detect image format by looking at the first few bytes of the compressed image data. You can call this method as soon as you have 8-16 bytes of compressed file content available.
the detected format or EImageFormat::Invalid if the method could not detect the image format.

code: EImageFormat DetectImageFormat ( const void * InCompressedData, int64 InCompressedSize )


description: Get a good default output image format for a pixel format

code: EImageFormat GetDefaultOutputFormat ( [ERawImageFormat::Type](API\Runtime\ImageCore\ERawImageFormat__Type) RawFormat )


description: Returns extension, not including the "." , 3 or 4 chars

code: const TCHAR * GetExtension ( EImageFormat Format )


description: Virtual destructor.

code: virtual ~IImageWrapperModule()


description: Name can be a full name like "xx.png" or just the extension part, like "png" returns EImageFormat::Invalid if no supported image extension found

code: EImageFormat GetImageFormatFromExtension ( const TCHAR * Name )


className: IImageWrapperModule

description: eg. if you write U8 Linear data to EXR, it will be converted to Linear float from U8 Linear correctly if you write U8 Linear to BMP , it will write the U8 bytes unchanged, and on load it will come back in as U8 SRGB

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


code: static FStringView GetFormatExtension ( EImageFormat InImageFormat, bool bIncludeDot )


code: static EImageFormat GetImageFormat ( FStringView StringExtention )


className: ImageWrapperHelper

code: class ImageWrapperHelper


code: static const FStringView GetImageFilesFilterString ( bool bIncludeAllFiles )


module: ImageWriteQueue

code: TUniquePtr< FImagePixelData > Copy&40;&41; const


description: Retrieve the number of bits per each channel of color in the data

code: uint8 GetBitDepth() const


description: Copy this whole image buffer. This can be very costly for large images.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > CopyImageData() const


description: Get the pixel data as anFImage


description: Return a pointer to the Payload stored in this data.

code: template<typename T> T * GetPayload()


description: Retrieve the number of channels in the data

code: uint8 GetNumChannels() const


description: Return a const pointer to the Payload stored in this data.

code: template<typename T> const T * GetPayload() const


description: Get the data and its size only if it is well formed

code: bool GetRawData ( const void *& OutRawData, int64 & OutSizeBytes ) const


description: Retrieve the pixel layout of this data

code: ERGBFormat GetPixelLayout() const


description: Get the size in bytes, regardless of if it is well formed.

code: int64 GetRawDataSizeInBytes() const


description: Retrieve the size of this data

code: FIntPoint GetSize() const


description: NOTE : before, U8 would be written to EXRlinearnow it will get gamma corrected if bSRGB (which is on by default) Retrieve the type of this data

code: EImagePixelType GetType() const


description: Check that this data is the size it should be

code: bool IsDataWellFormed() const


code: TUniquePtr< FImagePixelData > Move&40;&41;


description: Move this whole image buffer to a new allocation.


description: Sets the payload after construction.

code: void SetPayload ( FImagePixelPayloadPtr NewPayload )


description: Retrieve the raw pixel data

code: void RetrieveData &40; const void &42;& OutDataPtr, int64 & OutSizeBytes &41; const


code: void SetSRGB ( bool InSRGB )


code: FImagePixelData ( const FIntPoint & InSize, EImagePixelType InPixelType, ERGBFormat InPixelLayout, uint8 InBitDepth, uint8 InNumChannels, FImagePixelPayloadPtr InPayload )


code: virtual ~FImagePixelData()


className: FImagePixelData

code: struct FImagePixelData


description: Add a new end point handler to this pipe.

code: void AddEndpoint ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImageStreamEndpoint](API\Runtime\ImageWriteQueue\FImageStreamEndpoint) > && InEndpoint )


description: Add a new end point handler to this pipe as a functor.

code: void AddEndpoint ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > &&)> & InHandler )


description: Access this pipe's current set of end points. Warning: Not thread-safe - should only be called where no other modification to the end points can be happening.

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImageStreamEndpoint](API\Runtime\ImageWriteQueue\FImageStreamEndpoint) > > GetEndPoints() const


description: Push the specified pixel data onto this pipe

code: void Push ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > && InImagePixelData )


description: Default constructor (an empty pipe)

code: FImagePixelPipe()


description: Define a new pipe with a single initial endpoint

code: FImagePixelPipe ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > &&)> & InEndpoint )


className: FImagePixelPipe

description: A pipe that receives image data and forwards it onto 0 or more end points, copying the buffer as few times as possible

code: struct FImagePixelPipe


description: Pipe the specified image data onto this end point

code: void PipeImage ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > && InOwnedImage )


code: virtual ~FImageStreamEndpoint()


className: FImageStreamEndpoint

description: Stream end-point that receives a copy of image data from a thread

code: struct FImageStreamEndpoint


className: FImageWriteOptions

description: Options specific to writing image files to disk

code: struct FImageWriteOptions

bAsync

type: bool

description: Whether to perform the writing asynchronously, or to block the game thread until it is complete

bOverwriteFile

description: Whether to overwrite the image if it already exists

CompressionQuality

description: An image format specific compression setting.

Format

type: EDesiredImageFo...

description: The desired output image format to write to disk

NativeOnComplete

type: TFunction< void...

description: A native completion callback that will be called in addition to the dynamic one above.

OnComplete

type: FOnImageWriteCo...

description: A callback to invoke when the image has been written, or there was an error


code: virtual void OnAbandoned()


className: FImageWriteTask

code: class FImageWriteTask : public [IImageWriteTaskBase](API\Runtime\ImageWriteQueue\IImageWriteTaskBase)

bOverwriteFile

description: True if this task is allowed to overwrite an existing file, false otherwise.

CompressionQuality

description: A compression quality setting specific to the desired image format

Filename

type: FString

description: The filename to write to

Format

type: EImageFormat

description: The desired image format to write out

OnCompleted

description: A function to invoke on the game thread when the task has completed

PixelData

type: TUniquePtr<FIm...

description: The actual write operation.

PixelPreProcessors

type: TArray< FPixelP...

description: Array of preprocessors to apply serially to the pixel data when this task is executed.


className: FOnImageWriteComplete

code: class FOnImageWriteComplete


code: virtual ~IImagePixelDataPayload()


className: IImagePixelDataPayload

code: struct IImagePixelDataPayload


description:
Where the queue is empty, the future will be immediately fulfilled, and callback invoked on the next main thread tick.
A future that is fulfilled when the current state of the queue has been completely finished

code: [TFuture](API\Runtime\Core\Async\TFuture)< void > CreateFence ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> & InOnFenceReached )


description:
(thread-safe) Enqueue a new asynchronous image write task.
A future to the completion state of the task (success or failure), or an invalid future in the case where the task could not be dispatched

code: [TFuture](API\Runtime\Core\Async\TFuture)< bool > Enqueue ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IImageWriteTaskBase](API\Runtime\ImageWriteQueue\IImageWriteTaskBase) > && InTask, bool bInBlockIfAtCapacity )


description: (thread-safe) Query the number of tasks currently pending or in progress

code: int32 GetNumPendingTasks() const


className: IImageWriteQueue

description: Concurrency metrics are controllable by ImageWriteQueue.MaxConcurrency and ImageWriteQueue.MaxQueueSize Dispatched tasks can contain callbacks that are called on the main thread when completed. It is possible to wait on completion of the current queue state by creating a 'fence' that can be waited upon

code: class IImageWriteQueue


code: virtual ~IImageWriteQueue()


description: Access a global queue of image writing tasks


className: IImageWriteQueueModule

description: Module implementation that returns a write queue. Access is only via the module interface to ensure that the queue is flushed correctly on shutdown

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


description: Virtual destruction

code: virtual ~IImageWriteTaskBase()


className: IImageWriteTaskBase

description: Interface that is implemented in order to be able to asynchronously write images to disk

code: class IImageWriteTaskBase


className: TAsyncAlphaInvert

code: template<typename PixelType> struct TAsyncAlphaInvert


className: TAsyncAlphaInvert< FColor >::operator()

code: void operator&40;&41; &40; FImagePixelData &42; PixelData &41;


className: TAsyncAlphaInvert< FColor >

code: template<> struct TAsyncAlphaInvert< FColor >


className: TAsyncAlphaInvert< FFloat16Color >

code: template<> struct TAsyncAlphaInvert< FFloat16Color >


className: TAsyncAlphaInvert< FLinearColor >

code: template<> struct TAsyncAlphaInvert< FLinearColor >


className: TAsyncAlphaWrite

code: template<typename PixelType> struct TAsyncAlphaWrite


className: TAsyncAlphaWrite< FColor >::operator()


code: TAsyncAlphaWrite &40; uint8 InAlpha &41;


className: TAsyncAlphaWrite< FColor >

code: template<> struct TAsyncAlphaWrite< FColor >


code: TAsyncAlphaWrite &40; float InAlpha &41;


className: TAsyncAlphaWrite< FFloat16Color >

code: template<> struct TAsyncAlphaWrite< FFloat16Color >


className: TAsyncAlphaWrite< FLinearColor >

code: template<> struct TAsyncAlphaWrite< FLinearColor >

Alpha

type: float


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > Move()


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData) > Copy() const


description: Retrieve the raw pixel data

code: virtual void RetrieveData ( const void *& OutDataPtr, int64 & OutSizeBytes ) const


code: TImagePixelData ( const FIntPoint & InSize )


code: TImagePixelData ( const FIntPoint & InSize, TArray64< PixelType > && InPixels )


code: TImagePixelData ( const FIntPoint & InSize, FImagePixelPayloadPtr InPayload )


code: TImagePixelData ( const FIntPoint & InSize, TArray64< PixelType > && InPixels, FImagePixelPayloadPtr InPayload )


className: TImagePixelData

description: Templated pixel data - currently supportsFColor,FFloat16ColorandFLinearColor

code: template<typename PixelType> struct TImagePixelData : public [FImagePixelData](API\Runtime\ImageWriteQueue\FImagePixelData)

Pixels

type: TArray64< Pixel...


className: TImagePixelDataTraits

code: template<typename PixelType> struct TImagePixelDataTraits


className: BitDepth

code: enum &123; BitDepth = 8 &125;


className: NumChannels

code: enum &123; NumChannels = 4 &125;


className: PixelLayout

code: static PixelLayout = ERGBFormat::BGRA;


className: PixelType

code: static PixelType = EImagePixelType::Color;


className: TImagePixelDataTraits< FColor >

code: template<> struct TImagePixelDataTraits< FColor >


code: static PixelLayout = ERGBFormat::RGBAF;


code: static PixelType = EImagePixelType::Float16;


className: TImagePixelDataTraits< FFloat16Color >

code: template<> struct TImagePixelDataTraits< FFloat16Color >


code: static PixelType = EImagePixelType::Float32;


className: TImagePixelDataTraits< FLinearColor >

code: template<> struct TImagePixelDataTraits< FLinearColor >


description: Export the specified texture to disk

code: static void ExportToDisk ( [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FImageWriteOptions](API\Runtime\ImageWriteQueue\FImageWriteOptions) & Options )


className: UImageWriteBlueprintLibrary

description: Function library containing utility methods for writing images on a global async queue

code: class UImageWriteBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


code: static bool ResolvePixelData ( [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, const FOnPixelsReady & OnPixelsReady )


module: InputCore

code: namespace EConsoleForGamepadLabels { enum Type { None, XBoxOne, PS4, } }


className: Acceleration

code: static const [FKey](API\Runtime\InputCore\FKey) Acceleration;


className: A

code: static const [FKey](API\Runtime\InputCore\FKey) A;


className: Add

code: static const [FKey](API\Runtime\InputCore\FKey) Add;


code: static void AddKey ( const [FKeyDetails](API\Runtime\InputCore\FKeyDetails) & KeyDetails )


code: static void AddMenuCategoryDisplayInfo ( const [FName](API\Runtime\Core\UObject\FName) CategoryName, const [FText](API\Runtime\Core\Internationalization\FText) DisplayName, const [FName](API\Runtime\Core\UObject\FName) PaletteIcon )


code: static void AddPairedKey ( const [FKeyDetails](API\Runtime\InputCore\FKeyDetails) & PairedKeyDetails, [FKey](API\Runtime\InputCore\FKey) KeyX, [FKey](API\Runtime\InputCore\FKey) KeyY )


className: Ampersand

code: static const [FKey](API\Runtime\InputCore\FKey) Ampersand;


description: Android-specific.

code: static const [FKey](API\Runtime\InputCore\FKey) Android_Back;


code: static const [FKey](API\Runtime\InputCore\FKey) Android_Menu;


code: static const [FKey](API\Runtime\InputCore\FKey) Android_Volume_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Android_Volume_Up;


className: AnyKey

code: static const [FKey](API\Runtime\InputCore\FKey) AnyKey;


className: Apostrophe

code: static const [FKey](API\Runtime\InputCore\FKey) Apostrophe;


code: static const [FKey](API\Runtime\InputCore\FKey) A_AccentGrave;


className: Asterix

code: static const [FKey](API\Runtime\InputCore\FKey) Asterix;


className: B

code: static const [FKey](API\Runtime\InputCore\FKey) B;


className: Backslash

code: static const [FKey](API\Runtime\InputCore\FKey) Backslash;


className: BackSpace

code: static const [FKey](API\Runtime\InputCore\FKey) BackSpace;


className: bInitialized

code: static bool bInitialized = false;


className: C

code: static const [FKey](API\Runtime\InputCore\FKey) C;


className: CapsLock

code: static const [FKey](API\Runtime\InputCore\FKey) CapsLock;


className: Caret

code: static const [FKey](API\Runtime\InputCore\FKey) Caret;


className: Colon

code: static const [FKey](API\Runtime\InputCore\FKey) Colon;


className: Comma

code: static const [FKey](API\Runtime\InputCore\FKey) Comma;


className: ConsoleForGamepadLabels

code: static [EConsoleForGamepadLabels::Type](API\Runtime\InputCore\EConsoleForGamepadLabels__Type) ConsoleForGamepadLabels = EConsoleForGamepadLabels::None;


code: static const [FKey](API\Runtime\InputCore\FKey) C_Cedille;


className: D

code: static const [FKey](API\Runtime\InputCore\FKey) D;


className: Decimal

code: static const [FKey](API\Runtime\InputCore\FKey) Decimal;


className: Divide

code: static const [FKey](API\Runtime\InputCore\FKey) Divide;


className: Delete

code: static const [FKey](API\Runtime\InputCore\FKey) Delete;


className: Dollar

code: static const [FKey](API\Runtime\InputCore\FKey) Dollar;


className: Down

code: static const [FKey](API\Runtime\InputCore\FKey) Down;


className: E

code: static const [FKey](API\Runtime\InputCore\FKey) E;


className: Eight

code: static const [FKey](API\Runtime\InputCore\FKey) Eight;


className: End

code: static const [FKey](API\Runtime\InputCore\FKey) End;


className: Enter

code: static const [FKey](API\Runtime\InputCore\FKey) Enter;


className: Equals

code: static const [FKey](API\Runtime\InputCore\FKey) Equals;


className: Escape

code: static const [FKey](API\Runtime\InputCore\FKey) Escape;


className: Exclamation

code: static const [FKey](API\Runtime\InputCore\FKey) Exclamation;


code: static const [FKey](API\Runtime\InputCore\FKey) E_AccentGrave;


code: static const [FKey](API\Runtime\InputCore\FKey) E_AccentAigu;


code: static const [FKey](API\Runtime\InputCore\FKey) F10;


className: F

code: static const [FKey](API\Runtime\InputCore\FKey) F;


code: static const [FKey](API\Runtime\InputCore\FKey) F1;


code: static const [FKey](API\Runtime\InputCore\FKey) F11;


code: static const [FKey](API\Runtime\InputCore\FKey) F12;


code: static const [FKey](API\Runtime\InputCore\FKey) F2;


code: static const [FKey](API\Runtime\InputCore\FKey) F3;


code: static const [FKey](API\Runtime\InputCore\FKey) F5;


code: static const [FKey](API\Runtime\InputCore\FKey) F4;


code: static const [FKey](API\Runtime\InputCore\FKey) F7;


code: static const [FKey](API\Runtime\InputCore\FKey) F6;


code: static const [FKey](API\Runtime\InputCore\FKey) F8;


code: static const [FKey](API\Runtime\InputCore\FKey) F9;


className: Five

code: static const [FKey](API\Runtime\InputCore\FKey) Five;


className: Four

code: static const [FKey](API\Runtime\InputCore\FKey) Four;


className: G

code: static const [FKey](API\Runtime\InputCore\FKey) G;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_DPad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_DPad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_DPad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_DPad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_FaceButton_Bottom;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_FaceButton_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_FaceButton_Right;


description: Gamepad Keys.

code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Left2D;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_FaceButton_Top;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftShoulder;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftStick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftStick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftStick_Right;


description: Virtual key codes used for input axis button press/release emulation.

code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftStick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftThumbstick;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftTrigger;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftX;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftTriggerAxis;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_LeftY;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightStick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Right2D;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightStick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightShoulder;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightStick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightStick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightThumbstick;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightY;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightX;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Special_Left_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightTrigger;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_RightTriggerAxis;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Special_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Special_Left_X;


code: static const [FKey](API\Runtime\InputCore\FKey) Gamepad_Special_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Gesture_Rotate;


code: static const [FKey](API\Runtime\InputCore\FKey) Gesture_Flick;


code: static void GetAllKeys ( [TArray](API\Runtime\Core\Containers\TArray)< [FKey](API\Runtime\InputCore\FKey) > & OutKeys )


description: Gestures.

code: static const [FKey](API\Runtime\InputCore\FKey) Gesture_Pinch;


description: Function that provides remapping for some gamepad keys in display windows.

code: static [FText](API\Runtime\Core\Internationalization\FText) GetGamepadDisplayName ( const [FKey](API\Runtime\InputCore\FKey) Key )


code: static [FName](API\Runtime\Core\UObject\FName) GetMenuCategoryPaletteIcon ( const [FName](API\Runtime\Core\UObject\FName) CategoryName )


code: static [FText](API\Runtime\Core\Internationalization\FText) GetMenuCategoryDisplayName ( const [FName](API\Runtime\Core\UObject\FName) CategoryName )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FKeyDetails](API\Runtime\InputCore\FKeyDetails) > GetKeyDetails ( const [FKey](API\Runtime\InputCore\FKey) Key )


description: Xbox One global speech commands.

code: static const [FKey](API\Runtime\InputCore\FKey) Global_Menu;


code: static const [FKey](API\Runtime\InputCore\FKey) Global_Back;


code: static const [FKey](API\Runtime\InputCore\FKey) Global_Pause;


code: static const [FKey](API\Runtime\InputCore\FKey) Global_Play;


code: static const [FKey](API\Runtime\InputCore\FKey) Global_View;


className: Gravity

code: static const [FKey](API\Runtime\InputCore\FKey) Gravity;


className: H

code: static const [FKey](API\Runtime\InputCore\FKey) H;


className: Home

code: static const [FKey](API\Runtime\InputCore\FKey) Home;


className: Hyphen

code: static const [FKey](API\Runtime\InputCore\FKey) Hyphen;


className: I

code: static const [FKey](API\Runtime\InputCore\FKey) I;


className: InputKeys

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FKey](API\Runtime\InputCore\FKey), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FKeyDetails](API\Runtime\InputCore\FKeyDetails) > > InputKeys;


className: Insert

code: static const [FKey](API\Runtime\InputCore\FKey) Insert;


className: Invalid

code: static const [FKey](API\Runtime\InputCore\FKey) Invalid;


code: static bool IsAxis ( [FKey](API\Runtime\InputCore\FKey) Key )


code: static bool IsBindableInBlueprints ( const [FKey](API\Runtime\InputCore\FKey) Key )


code: static bool IsGamepadKey ( [FKey](API\Runtime\InputCore\FKey) Key )


description: These exist for backwards compatibility reasons only.

code: static bool IsModifierKey ( [FKey](API\Runtime\InputCore\FKey) Key )


className: K

code: static const [FKey](API\Runtime\InputCore\FKey) K;


className: J

code: static const [FKey](API\Runtime\InputCore\FKey) J;


className: L

code: static const [FKey](API\Runtime\InputCore\FKey) L;


className: Left

code: static const [FKey](API\Runtime\InputCore\FKey) Left;


className: LeftAlt

code: static const [FKey](API\Runtime\InputCore\FKey) LeftAlt;


className: LeftCommand

code: static const [FKey](API\Runtime\InputCore\FKey) LeftCommand;


className: LeftControl

code: static const [FKey](API\Runtime\InputCore\FKey) LeftControl;


className: LeftParantheses

code: static const [FKey](API\Runtime\InputCore\FKey) LeftParantheses;


className: LeftMouseButton

code: static const [FKey](API\Runtime\InputCore\FKey) LeftMouseButton;


className: LeftShift

code: static const [FKey](API\Runtime\InputCore\FKey) LeftShift;


className: LeftBracket

code: static const [FKey](API\Runtime\InputCore\FKey) LeftBracket;


className: M

code: static const [FKey](API\Runtime\InputCore\FKey) M;


className: MenuCategoryDisplayInfo

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), FCategoryDisplayInfo > MenuCategoryDisplayInfo;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Grip_Click;


description: Microsoft Mixed Reality Motion Controller.

code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Menu_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Left;


className: MiddleMouseButton

code: static const [FKey](API\Runtime\InputCore\FKey) MiddleMouseButton;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trackpad_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Left_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Grip_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Menu_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trackpad_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) MixedReality_Right_Trigger_Click;


className: MouseScrollDown

code: static const [FKey](API\Runtime\InputCore\FKey) MouseScrollDown;


code: static const [FKey](API\Runtime\InputCore\FKey) Mouse2D;


className: MouseWheelAxis

code: static const [FKey](API\Runtime\InputCore\FKey) MouseWheelAxis;


className: MouseScrollUp

code: static const [FKey](API\Runtime\InputCore\FKey) MouseScrollUp;


className: Multiply

code: static const [FKey](API\Runtime\InputCore\FKey) Multiply;


className: MouseY

code: static const [FKey](API\Runtime\InputCore\FKey) MouseY;


className: MouseX

code: static const [FKey](API\Runtime\InputCore\FKey) MouseX;


className: N

code: static const [FKey](API\Runtime\InputCore\FKey) N;


code: static const [FName](API\Runtime\Core\UObject\FName) NAME_GamepadCategory;


code: static const [FName](API\Runtime\Core\UObject\FName) NAME_KeyboardCategory;


className: Nine

code: static const [FKey](API\Runtime\InputCore\FKey) Nine;


code: static const [FName](API\Runtime\Core\UObject\FName) NAME_MouseCategory;


className: NumLock

code: static const [FKey](API\Runtime\InputCore\FKey) NumLock;


className: NumPadFive

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadFive;


className: NumPadEight

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadEight;


className: NumPadFour

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadFour;


className: NumPadSeven

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadSeven;


className: NumPadNine

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadNine;


className: NumPadSix

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadSix;


className: NumPadOne

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadOne;


className: NumPadThree

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadThree;


className: NumPadTwo

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadTwo;


className: NumPadZero

code: static const [FKey](API\Runtime\InputCore\FKey) NumPadZero;


description: XR key names are parseable into exactly 4 tokens.

code: static const int32 NUM_XR_KEY_TOKENS = 4;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Grip_Axis;


code: static const int32 NUM_TOUCH_KEYS = 11;


className: O

code: static const [FKey](API\Runtime\InputCore\FKey) O;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Grip_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Menu_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Trigger_Touch;


description: Oculus Touch Controller.

code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_X_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Y_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_X_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Left_Y_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_A_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_A_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_B_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_B_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Grip_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Grip_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_System_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) OculusTouch_Right_Trigger_Touch;


className: One

code: static const [FKey](API\Runtime\InputCore\FKey) One;


className: P

code: static const [FKey](API\Runtime\InputCore\FKey) P;


className: PageDown

code: static const [FKey](API\Runtime\InputCore\FKey) PageDown;


className: PageUp

code: static const [FKey](API\Runtime\InputCore\FKey) PageUp;


className: Pause

code: static const [FKey](API\Runtime\InputCore\FKey) Pause;


description: Platform Keys These keys platform specific versions of keys that go by different names. The delete key is a good example, on Windows Delete is the virtual key for Delete. On Macs, the Delete key is the virtual key for BackSpace.

code: static const [FKey](API\Runtime\InputCore\FKey) Platform_Delete = EKeys::Delete;


className: Period

code: static const [FKey](API\Runtime\InputCore\FKey) Period;


code: static const [FKey](API\Runtime\InputCore\FKey) PS4_Special;


className: Q

code: static const [FKey](API\Runtime\InputCore\FKey) Q;


className: Quote

code: static const [FKey](API\Runtime\InputCore\FKey) Quote;


className: R

code: static const [FKey](API\Runtime\InputCore\FKey) R;


code: static void RemoveKeysWithCategory ( const [FName](API\Runtime\Core\UObject\FName) InCategory )


className: Right

code: static const [FKey](API\Runtime\InputCore\FKey) Right;


className: RightAlt

code: static const [FKey](API\Runtime\InputCore\FKey) RightAlt;


className: RightBracket

code: static const [FKey](API\Runtime\InputCore\FKey) RightBracket;


className: RightControl

code: static const [FKey](API\Runtime\InputCore\FKey) RightControl;


className: RightCommand

code: static const [FKey](API\Runtime\InputCore\FKey) RightCommand;


className: RightMouseButton

code: static const [FKey](API\Runtime\InputCore\FKey) RightMouseButton;


className: RightParantheses

code: static const [FKey](API\Runtime\InputCore\FKey) RightParantheses;


className: RightShift

code: static const [FKey](API\Runtime\InputCore\FKey) RightShift;


className: S

code: static const [FKey](API\Runtime\InputCore\FKey) S;


className: RotationRate

code: static const [FKey](API\Runtime\InputCore\FKey) RotationRate;


className: ScrollLock

code: static const [FKey](API\Runtime\InputCore\FKey) ScrollLock;


className: Semicolon

code: static const [FKey](API\Runtime\InputCore\FKey) Semicolon;


className: Section

code: static const [FKey](API\Runtime\InputCore\FKey) Section;


code: static void SetConsoleForGamepadLabels ( const [EConsoleForGamepadLabels::Type](API\Runtime\InputCore\EConsoleForGamepadLabels__Type) Console )


className: Seven

code: static const [FKey](API\Runtime\InputCore\FKey) Seven;


className: Six

code: static const [FKey](API\Runtime\InputCore\FKey) Six;


className: Slash

code: static const [FKey](API\Runtime\InputCore\FKey) Slash;


className: SpaceBar

code: static const [FKey](API\Runtime\InputCore\FKey) SpaceBar;


code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Back_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Back_Left;


description: Steam Controller Specific.

code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Touch_0;


code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Touch_1;


code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Touch_2;


code: static const [FKey](API\Runtime\InputCore\FKey) Steam_Touch_3;


className: Subtract

code: static const [FKey](API\Runtime\InputCore\FKey) Subtract;


className: T

code: static const [FKey](API\Runtime\InputCore\FKey) T;


className: Three

code: static const [FKey](API\Runtime\InputCore\FKey) Three;


className: Tab

code: static const [FKey](API\Runtime\InputCore\FKey) Tab;


className: ThumbMouseButton

code: static const [FKey](API\Runtime\InputCore\FKey) ThumbMouseButton;


code: static const [FKey](API\Runtime\InputCore\FKey) ThumbMouseButton2;


className: Tilde

code: static const [FKey](API\Runtime\InputCore\FKey) Tilde;


className: Tilt

description: Static constFKeyVector axes (FVector; not float)

code: static const [FKey](API\Runtime\InputCore\FKey) Tilt;


className: TouchKeys

code: static const [FKey](API\Runtime\InputCore\FKey) TouchKeys;


className: Two

code: static const [FKey](API\Runtime\InputCore\FKey) Two;


className: U

code: static const [FKey](API\Runtime\InputCore\FKey) U;


className: Underscore

code: static const [FKey](API\Runtime\InputCore\FKey) Underscore;


className: Up

code: static const [FKey](API\Runtime\InputCore\FKey) Up;


className: V

code: static const [FKey](API\Runtime\InputCore\FKey) V;


description: ValveIndexController.

code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_A_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_A_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_B_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_B_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Grip_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_System_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Grip_Force;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_System_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Force;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trackpad_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Left_Trigger_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_A_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_A_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_B_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Grip_Force;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_B_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Grip_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_System_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_System_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_X;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Thumbstick_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Force;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trackpad_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Virtual_Back = FPlatformInput::GetGamepadBackKey();


code: static const [FKey](API\Runtime\InputCore\FKey) ValveIndex_Right_Trigger_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Grip_Click;


description: HTC Vive Controller

code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_System_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Click;


description: Virtual buttons that use other buttons depending on the platform.

code: static const [FKey](API\Runtime\InputCore\FKey) Virtual_Accept = FPlatformInput::GetGamepadAcceptKey();


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Menu_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trackpad_Y;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Left_Trigger_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Grip_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Menu_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_System_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_2D;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Click;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Down;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Left;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Right;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Touch;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Up;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_X;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trigger_Axis;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trackpad_Y;


className: W

code: static const [FKey](API\Runtime\InputCore\FKey) W;


code: static const [FKey](API\Runtime\InputCore\FKey) Vive_Right_Trigger_Click;


className: Y

code: static const [FKey](API\Runtime\InputCore\FKey) Y;


className: X

code: static const [FKey](API\Runtime\InputCore\FKey) X;


className: Z

code: static const [FKey](API\Runtime\InputCore\FKey) Z;


className: Zero

code: static const [FKey](API\Runtime\InputCore\FKey) Zero;


description: The number of entries in ETouchIndex must match the number of touch keys defined inEKeysand NUM_TOUCH_KEYS above.

code: namespace ETouchIndex { enum Type { Touch1, Touch2, Touch3, Touch4, Touch5, Touch6, Touch7, Touch8, Touch9, Touch10, CursorPointerIndex, MAX_TOUCHES, } }


description: Various states of touch inputs.

code: namespace ETouchType { enum Type { Began, Moved, Stationary, ForceChanged, FirstMove, Ended, NumTypes, } }


description: Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load

code: virtual void StartupModule()


className: FInputCoreModule

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


description: Returns the instance of the input key manager

code: static [FInputKeyManager](API\Runtime\InputCore\FInputKeyManager) & Get()


code: void GetCodesFromKey ( const [FKey](API\Runtime\InputCore\FKey) Key, const uint32 *& KeyCode, const uint32 *& CharCode ) const


description:
Retrieves the key mapped to the specified character code.
Retrieves the key mapped to the specified key or character code.

code: [FKey](API\Runtime\InputCore\FKey) GetKeyFromCodes ( const uint32 KeyCode, const uint32 CharCode ) const


className: Instance

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInputKeyManager](API\Runtime\InputCore\FInputKeyManager) > Instance;


className: FInputKeyManager

description: No constructors are accessible with public or protected access.

code: struct FInputKeyManager


code: bool ExportTextItem ( [FString](API\Runtime\Core\Containers\FString) & ValueStr, [FKey](API\Runtime\InputCore\FKey) const & DefaultValue, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Parent, int32 PortFlags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * ExportRootScope ) const


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


code: EPairedAxis GetPairedAxis() const


code: bool ImportTextItem ( const TCHAR *& Buffer, int32 PortFlags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Parent, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * ErrorText )


code: bool IsBindableInBlueprints() const


code: bool IsBindableToActions() const


description: Deprecated* Please use IsAxis1D instead.

code: bool IsFloatAxis() const


code: bool SerializeFromMismatchedTag ( struct [FPropertyTag](API\Runtime\CoreUObject\UObject\FPropertyTag) const & Tag, [FStructuredArchive::FSlot](API\Runtime\Core\Serialization\FStructuredArchive\FSlot) Slot )


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


className: SyntheticCharPrefix

code: static const TCHAR * SyntheticCharPrefix = TEXT("UnknownCharCode_");


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


code: FKey ( const ANSICHAR * InName )


description: Deprecated* Please use IsAxis2D/IsAxis3D instead.

code: bool IsVectorAxis() const


className: EInputAxisType

code: enum EInputAxisType { None, Button, Axis1D, Axis2D, Axis3D, }


className: EKeyFlags

code: enum EKeyFlags { GamepadKey = 1 << 0, Touch = 1 << 1, MouseButton = 1 << 2, ModifierKey = 1 << 3, NotBlueprintBindableKey = 1 << 4, Axis1D = 1 << 5, Axis3D = 1 << 6, UpdateAxisWithoutSamples = 1 << 7, NotActionBindableKey = 1 << 8, Deprecated = 1 << 9, ButtonAxis = 1 << 10, Axis2D = 1 << 11, Gesture = 1 << 12, NoFlags = 0, }


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


code: const [FKey](API\Runtime\InputCore\FKey) & GetKey() const


code: const [FKey](API\Runtime\InputCore\FKey) & GetPairedAxisKey() const


description: Key pairing.


code: FKeyDetails ( const [FKey](API\Runtime\InputCore\FKey) InKey, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLongDisplayName, const uint32 InKeyFlags, const [FName](API\Runtime\Core\UObject\FName) InMenuCategory, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InShortDisplayName )


code: FKeyDetails ( const [FKey](API\Runtime\InputCore\FKey) InKey, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLongDisplayName, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InShortDisplayName, const uint32 InKeyFlags, const [FName](API\Runtime\Core\UObject\FName) InMenuCategory )


code: static uint32 GetCharKeyMap ( uint32 * KeyCodes, [FString](API\Runtime\Core\Containers\FString) * KeyNames, uint32 MaxMappings )


code: static uint32 GetKeyMap ( uint32 * KeyCodes, [FString](API\Runtime\Core\Containers\FString) * KeyNames, uint32 MaxMappings )


description: Retrieves some standard key code mappings (usually called by a subclass's GetCharKeyMap)

code: static uint32 GetStandardPrintableKeyMap ( uint32 * KeyCodes, [FString](API\Runtime\Core\Containers\FString) * KeyNames, uint32 MaxMappings, bool bMapUppercaseKeys, bool bMapLowercaseKeys )


description: Remap a given key to something else if necessary.

code: static [FKey](API\Runtime\InputCore\FKey) RemapKey ( [FKey](API\Runtime\InputCore\FKey) Key )


className: FGenericPlatformInput

code: struct FGenericPlatformInput


code: static [IInputDebuggingInterface](API\Runtime\InputCore\IInputDebuggingInterface) & Get()


className: IInputDebuggingInterface

description: The public interface of the InputDeviceModule

code: class IInputDebuggingInterface : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


className: WithCopy

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


className: WithExportTextItem

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


className: WithImportTextItem

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


className: WithPostScriptConstruct

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


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


className: WithPostSerialize

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


className: TStructOpsTypeTraits< FKey >

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


className: UInputCoreTypes

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


description: Returns the scaling factor to map the amplitude of UHapticFeedbackEvents from [0.0, 1.0] to the actual range handled by the device

module: InputDevice

code: float GetHapticAmplitudeScale() const


description: Sets the frequency / amplitude of the haptic channel of a controller.

code: void SetHapticFeedbackValues ( int32 ControllerId, int32 Hand, const [FHapticFeedbackValues](API\Runtime\ApplicationCore\GenericPlatform\FHapticFeedbackValues) & Values )


className: IHapticDevice

code: class IHapticDevice


description: Determines the valid range of frequencies this haptic device supports, to limit input ranges from UHapticFeedbackEffects

code: void GetHapticFrequencyRange ( float & MinFrequency, float & MaxFrequency ) const


description: Exec handler to allow console commands to be passed through for debugging

code: bool Exec ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: If this device supports a haptic interface, implement this, and inherit theIHapticDeviceinterface

code: virtual [IHapticDevice](API\Runtime\InputDevice\IHapticDevice) * GetHapticDevice()


code: virtual bool IsGamepadAttached() const


code: virtual void ResetLightColor ( int32 ControllerId )


description: Poll for controller state and send events if needed

code: void SendControllerEvents()


description: Force Feedback pass through functions

code: void SetChannelValue ( int32 ControllerId, FForceFeedbackChannelType ChannelType, float Value )


description: Sets a property for a given controller id. Will be ignored for devices which don't support the property.

code: virtual void SetDeviceProperty ( int32 ControllerId, const [FInputDeviceProperty](API\Runtime\ApplicationCore\GenericPlatform\FInputDeviceProperty) * Property )


code: void SetChannelValues ( int32 ControllerId, const [FForceFeedbackValues](API\Runtime\ApplicationCore\GenericPlatform\FForceFeedbackValues) & values )


description: Pass though functions for light color

code: virtual void SetLightColor ( int32 ControllerId, [FColor](API\Runtime\Core\Math\FColor) Color )


description: Set which MessageHandler will get the events from SendControllerEvents.

code: void SetMessageHandler ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) > & InMessageHandler )


code: virtual bool SupportsForceFeedback ( int32 ControllerId )


description: Tick the interface (e.g. check for new controllers)

code: void Tick ( float DeltaTime )


className: IInputDevice

description: Input device interface. Useful for plugins/modules to support custom external input devices.

code: class IInputDevice


description:
Attempts to create a new head tracking device interface
Interface to the new head tracking device, if we were able to successfully create one

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IInputDevice](API\Runtime\InputDevice\IInputDevice) > CreateInputDevice ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FGenericApplicationMessageHandler](API\Runtime\ApplicationCore\GenericPlatform\FGenericApplicationMessageHandle-) > & InMessageHandler )


description: Singleton-like access toIInputDeviceModuleReturnsIInputDeviceModulesingleton instance, loading the module on demand if needed

code: static [IInputDeviceModule](API\Runtime\InputDevice\IInputDeviceModule) & Get()


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

code: static bool IsAvailable()


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

code: virtual void StartupModule()


className: IInputDeviceModule

code: class IInputDeviceModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Implementation for FInstallBundleStatsContainerBase.

module: InstallBundleManager

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


description: We should not ever really be serializing this base class. Kept it here for reference.

code: virtual void Serialize ( [FJsonSerializerBase](API\Runtime\Json\Serialization\FJsonSerializerBase) & Serializer, bool bFlatObject )


code: FBundlePersistentStats ( [FName](API\Runtime\Core\UObject\FName) BundleNameIn )


code: virtual ~FBundlePersistentStats()


className: FBundlePersistentStats

description: Each bundles persistent stats.

code: class FBundlePersistentStats : public [InstallBundleUtil::PersistentStats::FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase)


code: [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) & operator= ( const [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) & Other )


code: [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) & operator= ( [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) && Other )


code: FContentRequestSharedContext()


code: FContentRequestSharedContext ( const [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) & Other )


description: Remove default constructor as we require a BundleName in the constructor.


code: FContentRequestSharedContext ( [FContentRequestSharedContext](API\Runtime\InstallBundleManager\FContentRequestSharedContext) && Other )


className: FContentRequestSharedContext

code: struct FContentRequestSharedContext

BundleSourceSharedContext

type: TMap< EInstallB...


className: FContentRequestStateStats

code: struct FContentRequestStateStats

EndTime

type: double


className: FContentRequestSharedContextPtr


code: double GetElapsedTime() const


className: FContentRequestStats

code: struct FContentRequestStats

StateStats

type: TMap<FString, ...


code: const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [InstallBundleUtil::FContentRequestStats](API\Runtime\InstallBundleManager\FContentRequestStats) > & GetMap()


code: void StatsBegin ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: void StatsBegin ( [FName](API\Runtime\Core\UObject\FName) BundleName, const TCHAR * State )


code: void StatsEnd ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: void StatsEnd ( [FName](API\Runtime\Core\UObject\FName) BundleName, const TCHAR * State, uint64 DataSize )


description: Add a bundle to the cache.

code: void AddOrUpdateBundle ( EInstallBundleSourceType Source, const [FInstallBundleCacheBundleInfo](API\Runtime\InstallBundleManager\FInstallBundleCacheBundleInfo) & AddInfo )


code: void StatsReset ( [FName](API\Runtime\Core\UObject\FName) BundleName )


className: FContentRequestStatsMap

code: class FContentRequestStatsMap


code: bool ClearPendingEvict ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: bool Contains ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


code: bool Contains ( EInstallBundleSourceType Source, [FName](API\Runtime\Core\UObject\FName) BundleName ) const


className: ECacheState

code: enum ECacheState { Released, Reserved, PendingEvict, }


description: Called from bundle manager, returns all bundles that can be evicted.

code: [FInstallBundleCacheFlushResult](API\Runtime\InstallBundleManager\FInstallBundleCacheFlushResult) Flush ( EInstallBundleSourceType * Source )


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FInstallBundleCacheBundleInfo](API\Runtime\InstallBundleManager\FInstallBundleCacheBundleInfo) > GetBundleInfo ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FInstallBundleCacheBundleInfo](API\Runtime\InstallBundleManager\FInstallBundleCacheBundleInfo) > GetBundleInfo ( EInstallBundleSourceType Source, [FName](API\Runtime\Core\UObject\FName) BundleName ) const


description: Return the amount of free space in the cache, clamped to [0,GetSize()].

code: uint64 GetFreeSpace() const


description: Return the total size of the cache.

code: uint64 GetSize() const


code: [FInstallBundleCacheStats](API\Runtime\InstallBundleManager\FInstallBundleCacheStats) GetStats ( EInstallBundleCacheDumpToLog DumpToLog, bool bVerbose ) const


description: Return the amount of space in use. This could possbly exceedGetSize()if the cache size is changed or more bundles are added the to cache.

code: uint64 GetUsedSize() const


code: void Init ( [FInstallBundleCacheInitInfo](API\Runtime\InstallBundleManager\FInstallBundleCacheInitInfo) InitInfo )


description: Hint to the cache that this bundle is requested, and we should prefer to evict non-requested bundles if possible.

code: void HintRequested ( [FName](API\Runtime\Core\UObject\FName) BundleName, bool bRequested )


description: Called from bundle manager to make the files for this bundle eligible for eviction.

code: bool Release ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: void RemoveBundle ( EInstallBundleSourceType Source, [FName](API\Runtime\Core\UObject\FName) BundleName )


description: Called from bundle manager.

code: [FInstallBundleCacheReserveResult](API\Runtime\InstallBundleManager\FInstallBundleCacheReserveResult) Reserve ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: bool SetPendingEvict ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: virtual ~FInstallBundleCache()


className: FInstallBundleCache

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


className: FInstallBundleCacheBundleInfo

code: struct FInstallBundleCacheBundleInfo

BundleName

type: FName

TimeStamp

type: FDateTime


className: FInstallBundleCacheFlushResult

code: struct FInstallBundleCacheFlushResult

BundlesToEvict

type: TMap<FName,TA...


className: FInstallBundleCacheInitInfo

code: struct FInstallBundleCacheInitInfo


className: FInstallBundleCacheStats

code: struct FInstallBundleCacheStats


className: FInstallBundleCacheReserveResult

code: struct FInstallBundleCacheReserveResult

Result

type: EInstallBundleC...


code: bool GetAllBundlesHaveState ( EInstallBundleInstallState State, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > ExcludedBundles ) const


code: bool GetAnyBundleHasState ( EInstallBundleInstallState State, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > ExcludedBundles ) const


className: FInstallBundleCombinedContentState

IndividualBundleStates

type: TMap<FName,FI...


className: FInstallBundleCombinedInstallState

type: TMap<FName, EI...


className: ECombinedBundleStatus

description: Collapses all the bundle manager states into one of a few states so that you can show simple text based on this enum.

code: enum ECombinedBundleStatus { Unknown, Initializing, Updating, Finishing, Finished, Count, }


className: FCombinedProgress

description: Provide all our needed combined status information in 1 struct

code: struct FCombinedProgress

bBundleRequiresUpdate

type: bool

CombinedPauseFlags

type: EInstallBundleP...

CombinedStatus

type: ECombinedBundle...