FTiledOutputFile | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/OpenExrWrapper

Use this to write out tiled EXR images using the general interface.

Add any attributes and AddChannel after construction. Then you can call CreateOutputFile. Then you can call AddFrameBufferChannel for each channel, and then SetFrameBuffer. After that, you can write out data to the file.


Name	FTiledOutputFile
Type	class
Header File	/Engine/Plugins/Media/ImgMedia/Source/OpenExrWrapper/Public/OpenExrWrapper.h
Include Path	#include "OpenExrWrapper.h"

Syntax

class FTiledOutputFile : public FBaseOutputFile

Inheritance Hierarchy

FBaseOutputFile → FTiledOutputFile

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FTiledOutputFile ( const FIntPoint& DisplayWindowMin, const FIntPoint& DisplayWindowMax, const FIntPoint& DataWindowMin, const FIntPoint& DataWindowMax, bool bInIsTiled )	Constructor.	OpenExrWrapper.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FTiledOutputFile()	Destructor.	OpenExrWrapper.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bIsTiled	bool	True if tiles are enabled.	OpenExrWrapper.h
FrameBuffer	void *	Stores the EXR frame buffer object.	OpenExrWrapper.h

Functions

Public

Name	Remarks	Include Path
void AddChannel ( const FString& Name )	Call this before CreateOutputFile for each channel in the image.	OpenExrWrapper.h
void AddFrameBufferChannel ( const FString& Name, void* Base, const FIntPoint& Stride )	Call this before SetFrameBuffer for each channel in the frame buffer.	OpenExrWrapper.h
void CreateOutputFile ( const FString& FilePath, int32 TileWidth, int32 TileHeight, bool bIsMipsEnabled, int32 NumThreads )	Call this after adding any attributes or channels BUT before doing anything else.	OpenExrWrapper.h
int32 GetMipHeight ( int32 MipLevel )	Get the height of a mip level.	OpenExrWrapper.h
int32 GetMipWidth ( int32 MipLevel )	Get the width of a mip level.	OpenExrWrapper.h
int32 GetNumXTiles ( int32 MipLevel )	Get number of horizontal tiles for a mip level.	OpenExrWrapper.h
int32 GetNumYTiles ( int32 MipLevel )	Get number of vertical tiles for a mip level.	OpenExrWrapper.h
void SetFrameBuffer()	Call this prior to WriteTile to set where the data is coming from.	OpenExrWrapper.h
void UpdateFrameBufferChannel ( const FString& Name, void* Base, const FIntPoint& Stride )	Call this to change a channel in the frame buffer.	OpenExrWrapper.h
void WriteTile ( int32 TileX, int32 TileY, int32 MipLevel )	Call this to write data to a specific tile.	OpenExrWrapper.h
void WriteTiles ( int32 TileX1, int32 TileX2, int32 TileY1, int32 TileY2, int32 MipLevel )	Call this to write data to some tiles.	OpenExrWrapper.h

Overridden from FBaseOutputFile

Name	Remarks	Include Path	Unreal Specifiers
virtual int32 GetNumberOfMipLevels()	Call this to get the number of mipmap levels.	OpenExrWrapper.h

Navigation