1. Epic GamesDeveloper
  3. FHdrImageWrapper

FHdrImageWrapper

Does not use ImageWrapperBase , unlike all other imagewrappers

API > API/Runtime > API/Runtime/ImageWrapper

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)

   
Name FHdrImageWrapper
Type class
Header File /Engine/Source/Runtime/ImageWrapper/Public/Formats/HdrImageWrapper.h
Include Path #include "Formats/HdrImageWrapper.h"

Syntax

class FHdrImageWrapper : public IImageWrapper

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CompressedData TArrayView64< const uint8 >   Formats/HdrImageWrapper.h  
CompressedDataHolder TArray64< uint8 >   Formats/HdrImageWrapper.h  
ErrorMessage FText Reported error. Formats/HdrImageWrapper.h  
Height int64 INDEX_NONE if not valid Formats/HdrImageWrapper.h  
RawDataHolder TArray64< uint8 >   Formats/HdrImageWrapper.h  
RGBDataStart const uint8 *   Formats/HdrImageWrapper.h  
Width int64 INDEX_NONE if not valid Formats/HdrImageWrapper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void FreeCompressedData()

   Formats/HdrImageWrapper.h  

const FText & GetErrorMessage()

 GetErrorMessage : nice idea, but not virtual, never called by the standard import path. Formats/HdrImageWrapper.h  

bool GetRaw ( FDecompressedImageOutput& OutDecompressedImage
)

 GetRaw after SetCompressed fills the raw data in the native format/depth contained in the file along with meta info Do not use the GetRaw() variants that take format/depth arguments. Formats/HdrImageWrapper.h  

bool GetRaw ( TArray64< uint8 >& OutRawData
)

 GetRaw after SetCompressed fills the raw data in the native format/depth contained in the file Do not use the GetRaw() variants that take format/depth arguments. Formats/HdrImageWrapper.h  

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

 Get the raw version of the image and write to the array view (Note: It may consume the data set in the SetRaw function if it was set before) Formats/HdrImageWrapper.h  

bool GetRaw ( const ERGBFormat InFormat,
int32 InBitDepth,
TArray< uint8 >& OutRawData
)

 Gets the raw data in a TArray. Formats/HdrImageWrapper.h  

bool SetCompressedFromView ( TArrayView64< const uint8 > Data
)

 Todo we should have this for all image wrapper. Formats/HdrImageWrapper.h  

Overridden from IImageWrapper

Name Remarks Include Path Unreal Specifiers

virtual void AddMetadata ( const FString& InKey,
const FString& InValue
)

 Adds a key and value to this image's metadata. Formats/HdrImageWrapper.h  

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

 CanSetRawFormat returns true if SetRaw will accept this format Formats/HdrImageWrapper.h  

virtual int32 GetBitDepth ()

 Gets the bit depth of the image. Formats/HdrImageWrapper.h  

virtual TArray64< uint8 > GetCompressed ( int32 Quality
)

 Gets the compressed data. Formats/HdrImageWrapper.h  

virtual ERGBFormat GetFormat ()

 Gets the format of the image. Formats/HdrImageWrapper.h  

virtual int64 GetHeight ()

 Gets the height of the image. Formats/HdrImageWrapper.h  

virtual bool GetRaw ( const ERGBFormat InFormat,
int32 InBitDepth,
FDecompressedImageOutput& OutDecompressedImage
)

 Gets the raw data and meta info (Note: It may consume the data set in the SetRaw function if it was set before) Formats/HdrImageWrapper.h  

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

 Gets the raw data. Formats/HdrImageWrapper.h  

virtual ERawImageFormat::Type GetSupportedRawFormat ( const ERawImageFormat::Type InFormat
) const

 Returns InFormat if supported, else maps to something supported the returned format will pass CanSetRawFormat() Formats/HdrImageWrapper.h  

virtual int64 GetWidth ()

 Gets the width of the image. Formats/HdrImageWrapper.h  

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

 Sets the compressed data. Formats/HdrImageWrapper.h  

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

 Sets the raw image data. Formats/HdrImageWrapper.h  

virtual bool SupportsMetadata ()

 Does this image type support embedded metadata in its header? Formats/HdrImageWrapper.h  

virtual bool TryGetMetadata ( const FString& InKey,
FString& OutValue
) const

 Queries a key from this image's metadata. Formats/HdrImageWrapper.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool HaveBytes ( const uint8* InCursor,
const uint8* InEnd,
int InAmount
)

   Formats/HdrImageWrapper.h  

static bool ParseImageSize ( const char* InLine,
int* OutWidth,
int* OutHeight
)

   Formats/HdrImageWrapper.h  

static bool ParseMatchString ( const char*& InOutCursor,
const char* InExpected
)

   Formats/HdrImageWrapper.h  

static bool ParsePositiveInt ( const char*& InOutCursor,
int* OutValue
)

   Formats/HdrImageWrapper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page