UTexture::GetAverageBrightness

Gets the average brightness of the texture (in linear space)

Windows
MacOS
Linux

Override Hierarchy

UTexture::GetAverageBrightness()

UTexture2D::GetAverageBrightness()

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/Texture.h

Include

#include "Engine/Texture.h"

Source

/Engine/Source/Runtime/Engine/Private/Texture.cpp

Syntax

virtual float GetAverageBrightness
(
    bool bIgnoreTrueBlack,
    bool bUseGrayscale
)

Remarks

Gets the average brightness of the texture (in linear space)

Returns

float The average brightness of the texture

Parameters

Parameter

Description

bIgnoreTrueBlack

If true, then pixels w/ 0,0,0 rgb values do not contribute.

bUseGrayscale

If true, use gray scale else use the max color component.

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