UTextureLODSettings

Structure containing all information related to an LOD group and providing helper functions to calculate the LOD bias of a given group.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/TextureLODSettings.h

Include

#include "Engine/TextureLODSettings.h"

Syntax

class UTextureLODSettings : public UObject

Remarks

Structure containing all information related to an LOD group and providing helper functions to calculate the LOD bias of a given group.

Variables

Name Description

Public variable

TArray< FTextur...

 

TextureLODGroups

Array of LOD settings with entries per group.

Constructors

Name Description

Public function

UTextureLODSettings

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

int32

 

CalculateLODBias

(
    const UTexture* Texture,
    bool bIncCinematicMips
)

Calculates and returns the LOD bias based on texture LOD group, LOD bias and maximum size.

Public function Const

int32

 

CalculateLODBias

(
    int32 Width,
    int32 Height,
    int32 MaxSize,
    int32 LODGroup,
    int32 LODBias,
    int32 NumCinematicMipLevels,
    TextureMipGenSettings MipGenSetting,
    bool bVirtualTexture
)

Calculates and returns the LOD bias based on the information provided.

Public function Const

int32

 

CalculateNumOptionalMips

(
    int32 LODGroup,
    const int32 Width,
    const int32 Height,
    const int32 NumMips,
    const int32 MinMipToInline,
    TextureMipGenSettings InMipGenSetti...
)

Calculate num optional mips

Public function Const

void

 

GetMipGenSettings

(
    const UTexture& Texture,
    TextureMipGenSettings& OutMipGenSe...,
    float& OutSharpen,
    uint32& OutKernelSize,
    bool& bOutDownsampleWithAverage,
    bool& bOutSharpenWithoutColorShift,
    bool& bOutBorderColorBlack
)

Public function Const

ETextureMipL...

 

GetMipLoadOptions

(
    const UTexture* Texture
)

Returns the mip load options of a texture.

Public function Const

ETextureSamp...

 

GetSamplerFilter

(
    const UTexture* Texture
)

Returns the filter state that should be used for the passed in texture, taking into account other system settings.

Public function Const

ETextureSamp...

 

GetSamplerFilter

(
    int32 InLODGroup
)

Public function Static

TArray< FStr...

 

GetTextureGroupNames()

Returns the texture group names, sorted like enum.

Public function

FTextureLODG...

 

GetTextureLODGroup

(
    TextureGroup GroupIndex
)

TextureLODGroups access with bounds check

Public function Const

const FTextu...

 

GetTextureLODGroup

(
    TextureGroup GroupIndex
)

TextureLODGroups access with bounds check

Public function Const

const Textur...

 

GetTextureMipGenSettings

(
    int32 InLODGroup
)

Returns the LODGroup mip gen settings

Protected function

void

 

SetupLODGroup

(
    int32 GroupId
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback