Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ImgMedia > FImgMediaMipMapInfo

Light Theme

Dark Theme

FImgMediaMipMapInfo

Contains information for working with mip maps.

Windows

MacOS

Linux

Inheritance Hierarchy

IMediaOptions::FDataContainer

FTickableGameObject

FImgMediaMipMapInfo

References

Module	ImgMedia
Header	/Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/ImgMediaMipMapInfo.h
Include	#include "ImgMediaMipMapInfo.h"

Syntax

class FImgMediaMipMapInfo :
public IMediaOptions::FDataContainer,
public FTickableGameObject

Remarks

Contains information for working with mip maps.

Variables

	Name	Description
bool	bIsCachedMipLevelValid	True if the cached mipmap data has been calculated this frame.
bool	bIsMipLevel0DistanceSetManually	True if MipLevel0Distance has been set manually.
int32	CachedMipLevel	Desired mipmap level at this current time.
FImgMediaTileSe...	CachedTileSelection	Desired tiles at this current tmie.
TArray< FImgMed...	CameraInfos	Info for each camera, used in mipmap calculations.
FCriticalSectio...	InfoCriticalSection	Protects info variables.
float	MipLevel0Distance	Ideal distance for mip level 0.
TArray< float >	MipLevelDistances	Ideal distances for all mip maps.
TArray< FImgMed...	Objects	Array of objects that are using our img sequence.
FName	SequenceName	Name of this sequence.
float	ViewportDistAdjust	Adjustment for current size of viewport, used in mipmap calculations.

Constructors

	Name	Description
	FImgMediaMipMapInfo()

Destructors

	Name	Description
	~FImgMediaMipMapInfo()

Functions

	Name	Description
void	AddObject ( AActor* InActor, float Width, float LODBias )	This object is using our img sequence.
void	AddObjectsUsingThisMediaTexture ( UMediaTexture* InMediaTexture )	All the objets that are using this media texture will be used in our mip map calculations.
void	ClearAllObjects()	Remove all objects from consideration.
const TArray...	GetCameraInfo()	Get information on all our cameras.
int32	GetDesiredMipLevel ( FImgMediaTileSelection& InTileSele... )	Get what mipmap level should be used.
const TArray...	GetMipLevelDistances()	Get our mip level distances.
int	GetMipLevelForDistance ( float InDistance, const TArray< float >& InMipLevelD... )	Determine which mip level to use for a given distance.
float	GetObjectDistToCamera ( const FVector& InCameraLocation, const FVector& InObjectLocation )	Calculate object distance to camera.
const TArray...	GetObjects()	Get information on objects that are using our textures.
float	GetObjectWidth ( const AActor* InActor )	Determine the size of an object.
float	GetViewportDistAdjust()	Get adjustment needed for distance to take the viewport size into account compared to the reference viewport
void	RemoveObject ( AActor* InActor )	This object is no longer using our img sequence.
void	SetMipLevelDistance ( float Distance )	Manually set when mip level 0 should appear.
void	SetTextureInfo ( FName InSequenceName, int NumMipMaps, const FIntPoint& Dim )	Provide information on the texture needed for our image sequence.
void	UpdateMipLevelCache()	Performs mipmap calculations and caches the data.
void	UpdateMipLevelDistances()	Updates the MipLevelDistances based on current information.

Overridden from FTickableObjectBase

		Name	Description
	TStatId	GetStatId()	Return the stat id to use for this tickable
	void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

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

Take our survey

Dismiss