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.

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