FObjectThumbnail

Thumbnail image data for an object.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/ObjectThumbnail.h

Include

#include "Misc/ObjectThumbnail.h"

Syntax

class FObjectThumbnail

Remarks

Thumbnail image data for an object.

Constructors

Name Description

Public function

FObjectThumbnail()

Default constructor.

Functions

Name Description

Public function

TArray< uint...

 

AccessCompressedImageData()

Access the compressed image data.

Public function Const

const TArray...

 

AccessImageData()

Access the image data in place (does not decompress) const version.

Public function

TArray< uint...

 

AccessImageData()

Access the image data in place (does not decompress).

Public function

void

 

CompressImageData()

Compress image data.

Public function Const

void

 

CountBytes

(
    FArchive& Ar
)

Calculates the memory usage of this FObjectThumbnail.

Public function Const

void

 

CountImageBytes_Compressed

(
    FArchive& Ar
)

Calculates the amount of memory used by the compressed bytes array.

Public function Const

void

 

CountImageBytes_Uncompressed

(
    FArchive& Ar
)

Calculates the amount of memory used by the uncompressed bytes array.

Public function

void

 

DecompressImageData()

Decompress image data.

Public function Const

int32

 

GetCompressedDataSize()

Public function Const

int32

 

GetImageHeight()

Returns the height of the thumbnail.

Public function Const

int32

 

GetImageWidth()

Returns the width of the thumbnail.

Public function Const

const TArray...

 

GetUncompressedImageData()

Returns uncompressed image data, decompressing it on demand if needed.

Public function Const

bool

 

IsCreatedAfterCustomThumbsEnabled()

Returns true if the thumbnail was saved AFTER custom-thumbnails for shared thumbnail asset types was supported.

Public function Const

bool

 

IsDirty()

Returns true if the thumbnail is dirty and needs to be regenerated at some point.

Public function Const

bool

 

IsEmpty()

Returns true if this is an empty thumbnail.

Public function Const

bool

 

IsLoadedFromDisk()

Returns true if the thumbnail was loaded from disk and not dynamically generated.

Public function

void

 

MarkAsDirty()

Marks the thumbnail as dirty.

Public function

void

 

Serialize

(
    FArchive& Ar
)

Serializers

Public function

void

 

Serialize

(
    FStructuredArchive::FSlot Slot
)

Serializers

Public function

void

 

SetCreatedAfterCustomThumbsEnabled()

For newly generated custom thumbnails, mark it as valid in the future.

Public function

void

 

SetImageSize

(
    int32 InWidth,
    int32 InHeight
)

Sets the image dimensions.

Public function Static

void

 

SetThumbnailCompressor

Static: Sets the thumbnail compressor to use when loading/saving packages.

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FObjectThumbnail& Other
)

Public function Const

bool

 

operator==

(
    const FObjectThumbnail& Other
)

Comparison operator

Constants

Name

Description

ThumbnailCompressor

Static: Thumbnail compressor.

Static: Thumbnail compressor

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss