UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
CubemapHelpers Namespace Reference

Functions

bool GenerateLongLatUnwrap (const FTextureResource *TextureResource, const uint32 AxisDimenion, const EPixelFormat SourcePixelFormat, TArray64< uint8 > &BitsOUT, FIntPoint &SizeOUT, EPixelFormat &FormatOUT)
 
bool GenerateLongLatUnwrap (const UTextureCube *CubeTexture, TArray64< uint8 > &BitsOUT, FIntPoint &SizeOUT, EPixelFormat &FormatOUT)
 
bool GenerateLongLatUnwrap (const UTextureRenderTargetCube *CubeTarget, TArray64< uint8 > &BitsOUT, FIntPoint &SizeOUT, EPixelFormat &FormatOUT)
 

Function Documentation

◆ GenerateLongLatUnwrap() [1/3]

bool CubemapHelpers::GenerateLongLatUnwrap ( const FTextureResource TextureResource,
const uint32  AxisDimenion,
const EPixelFormat  SourcePixelFormat,
TArray64< uint8 > &  BitsOUT,
FIntPoint SizeOUT,
EPixelFormat FormatOUT 
)

Helper function to create an unwrapped 2D image of the cube map ( longitude/latitude ) This version takes explicitly passed properties of the source object, as the sources have different APIs.

Parameters
TextureResourceSource FTextureResource object.
AxisDimenionaxis length of the cube.
SourcePixelFormatpixel format of the source.
BitsOUTRaw bits of the 2D image bitmap.
SizeXOUTFilled with the X dimension of the output bitmap.
SizeYOUTFilled with the Y dimension of the output bitmap.
Returns
true on success.
Parameters
FormatOUTFilled with the pixel format of the output bitmap.

◆ GenerateLongLatUnwrap() [2/3]

ENGINE_API bool CubemapHelpers::GenerateLongLatUnwrap ( const UTextureCube CubeTexture,
TArray64< uint8 > &  BitsOUT,
FIntPoint SizeOUT,
EPixelFormat FormatOUT 
)

Creates an unwrapped 2D image of the cube map ( longitude/latitude )

Parameters
CubeTextureSource UTextureCube object.
BitsOUTRaw bits of the 2D image bitmap.
SizeXOUTFilled with the X dimension of the output bitmap.
SizeYOUTFilled with the Y dimension of the output bitmap.
FormatOUTFilled with the pixel format of the output bitmap.
Returns
true on success.

◆ GenerateLongLatUnwrap() [3/3]

ENGINE_API bool CubemapHelpers::GenerateLongLatUnwrap ( const UTextureRenderTargetCube CubeTarget,
TArray64< uint8 > &  BitsOUT,
FIntPoint SizeOUT,
EPixelFormat FormatOUT 
)

Creates an unwrapped 2D image of the cube map ( longitude/latitude )

Parameters
CubeTargetSource UTextureRenderTargetCube object.
BitsOUTRaw bits of the 2D image bitmap.
SizeXOUTFilled with the X dimension of the output bitmap.
SizeYOUTFilled with the Y dimension of the output bitmap.
FormatOUTFilled with the pixel format of the output bitmap.
Returns
true on success.