1. Epic GamesDeveloper
  3. Image

Image

2D image resource with mipmaps.

API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR

Inheritance Hierarchy

References

   
Module MutableRuntime
Header /Engine/Plugins/Experimental/Mutable/Source/MutableRuntime/Public/MuR/Image.h
Include #include "MuR/Image.h"

Syntax

class Image : public mu::Resource

Remarks

2D image resource with mipmaps.

Variables

  Type Name Description
Public variable ImageDataContainerType m_data  
Public variable uint8 m_flags Persistent flags with some image properties. The meaning will depend of every context.
Public variable EImageFormat m_format  
Public variable uint8 m_lods Levels of detail (mipmaps)
Public variable FImageSize m_size  
Public variable uint32 ReferenceID Only valid if the right flags are set, this identifies a referenced image.
Public variable uint16 RelevancyMaxY  
Public variable uint16 RelevancyMinY Non-persistent relevancy map.

Constructors

  Type Name Description
Public function  

Image ()

 Life cycle.
Public function  

Image ( uint32 sizeX,
uint32 sizeY,
uint32 lods,
EImageFormat format,
EInitializationType Init
)

 Constructor from the size and format.

Destructors

  Type Name Description
Protected function  

~Image ()

 Forbidden. Manage with the Ptr<> template.

Functions

  Type Name Description
Public function Const int32 Calculate the size of the image data in bytes, regardless of what is allocated in m_data, only using the image descriptions.
Public function Const int32

CalculateDataSize ( int lod
)

 Calculate the size of a lod of the image data in bytes, regardless of what is allocated in m_data, only using the image descriptions.
Public function Static int32

CalculateDataSize ( int32 SizeX,
int32 SizeY,
int32 LodCount,
EImageFormat Format
)

 Calculate the size of the image data in bytes, regardless of what is allocated in m_data, only using the image descriptions.
Public function Const FIntVector2

CalculateMipSize ( int lod
)

 Calculate the size in pixels of a particular mipmap of this image.
Public function Const int32

CalculatePixelCount ( int lod
)

 Same as above, but only calculates the pixels of an lod.
Public function Const int32 Calculate the number of pixels of the image, regardless of what is allocated in m_data, only using the image descriptions.
Public function Const Ptr< Image >

Clone ()

 Deep clone.
Public function void

Copy ( const Image* Other
)

 Copy another image.
Public function void

CopyMove ( Image* Other
)

  
Public function Static Ptr< Image >

CreateAsReference ( uint32 ID
)

  
Public function uint8 *

GetData ()

 Return a pointer to a instance-owned buffer where the image pixels are.
Public function Const const uint8 *

GetData ()

 Return a pointer to a instance-owned buffer where the image pixels are.
Public function Const EImageFormat Return the pixel format of the image.
Public function Const int Return the number of levels of detail (mipmaps) in the texture.
Public function Const int32

GetLODDataSize ( int lod
)

 Return the size in bytes of a specific LOD of the image.
Public function uint8 *

GetMipData ( int mip
)

 Return a pointer to the beginning of the data for a particular mip.
Public function Const const uint8 *

GetMipData ( int mip
)

 Return a pointer to the beginning of the data for a particular mip.
Public function Static int

GetMipmapCount ( int SizeX,
int SizeY
)

 Calculate the number of mipmaps for a particular image size.
Public function Const int32 Return the size of the resident mips.
Public function Const void Get the rect inside the image bounding the non-black content of the image.
Public function Const void Get the rect inside the image bounding the non-black content of the image.
Public function Const uint32 Return the id of the engine referenced texture. Only valid if IsReference.
Public function Const const FImageSize &

GetSize ()

  
Public function Const uint16 Return the width of the image.
Public function Const uint16 Return the height of the image.
Public function void Clear the image to black colour.
Public function Const bool See if all the pixels in the alpha channel are the max value of the pixel format (white).
Public function Const bool

IsPlainColour ( FVector4f& colour
)

 See if all the pixels in the image are equal and return the colour.
Public function Const bool Return true if this is a reference to an engine image.
Public function void

ReduceLODs ( int32 LODsToSkip
)

 Reduce the LODs of the image to the given amount.
Public function void

ReduceLODsTo ( int32 NewLODCount
)

 Reduce the LODs of the image to the given amount.
Public function Const FVector4f

Sample ( FVector2f coords
)

 Sample the image and return an RGB colour.
Public function Const void  
Public function Static void

Serialise ( const Image* p,
OutputArchive& arch
)

 Serialisation.
Public function Static Ptr< Image >  
Public function void  

Overridden from Resource

  Type Name Description
Public function Virtual Const int32 Return the size in bytes of all the LODs of the image.

Operators

  Type Name Description
Public function Const bool

operator== ( const Image& o
)

  

Enums

  Type Name Description
Public enum EImageFlags These set of flags are used to cache information for images at runtime.  

Typedefs

Name Description
ImageDataContainerType Pixel data for all lods.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page