Navigation
API > API/Runtime > API/Runtime/Core
Information about a pixel format. The majority of this structure is valid after static init, however RHI does keep some state in here that is initialized by that module and should not be used by general use programs that don't have RHI (so noted in comments).
| Name | FPixelFormatInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/PixelFormat.h |
| Include Path | #include "PixelFormat.h" |
Syntax
struct FPixelFormatInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| PixelFormat.h | |||
FPixelFormatInfo
(
EPixelFormat InUnrealFormat, |
PixelFormat.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIs24BitUnormDepthStencil | uint8 | If false, 32 bit float is assumed (initialized by RHI module - invalid otherwise) | PixelFormat.h | |
| BlockBytes | int32 | PixelFormat.h | ||
| BlockSizeX | int32 | PixelFormat.h | ||
| BlockSizeY | int32 | PixelFormat.h | ||
| BlockSizeZ | int32 | PixelFormat.h | ||
| Capabilities | EPixelFormatCapabilities | Per platform cabilities for the format (initialized by RHI module - invalid otherwise) | PixelFormat.h | |
| Name | const TCHAR * | PixelFormat.h | ||
| NumComponents | int32 | PixelFormat.h | ||
| PlatformFormat | uint32 | Platform specific converted format (initialized by RHI module - invalid otherwise) | PixelFormat.h | |
| Supported | uint8 | Whether the texture format is supported on the current platform/ rendering combination | PixelFormat.h | |
| UnrealFormat | EPixelFormat | PixelFormat.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 Get2DImageSizeInBytes
(
uint32 InWidth, |
Get 2D/3D image/texture size in bytes. | PixelFormat.h | |
uint64 Get2DTextureMipSizeInBytes
(
uint32 InTextureWidth, |
PixelFormat.h | ||
uint64 Get2DTextureSizeInBytes
(
uint32 InTextureWidth, |
PixelFormat.h | ||
uint64 Get3DImageSizeInBytes
(
uint32 InWidth, |
PixelFormat.h | ||
uint64 Get3DTextureMipSizeInBytes
(
uint32 InTextureWidth, |
PixelFormat.h | ||
uint64 Get3DTextureSizeInBytes
(
uint32 InTextureWidth, |
PixelFormat.h | ||
uint64 GetBlockCountForHeight
(
uint32 InHeight |
PixelFormat.h | ||
uint64 GetBlockCountForWidth
(
uint32 InWidth |
Get the number of compressed blocks necessary to hold the given dimensions. | PixelFormat.h |