TSHVectorRGB

A vector of colored spherical harmonic coefficients.

Windows
MacOS
Linux

Syntax

template<int32 MaxSHOrder>
class TSHVectorRGB

Remarks

A vector of colored spherical harmonic coefficients.

Variables

Name Description

Public variable

TSHVector< MaxS...

 

B

Public variable

TSHVector< MaxS...

 

G

Public variable

TSHVector< MaxS...

 

R

Constructors

Name Description

Public function

TSHVectorRGB()

Public function

TSHVectorRGB

(
    const TSHVectorRGB< OtherOrder >& ...
)

Functions

Name Description

Public function

void

 

AddAmbient

(
    const FLinearColor& Intensity
)

Adds ambient lighting.

Public function

void

 

AddIncomingRadiance

(
    const FLinearColor& IncomingRadian...,
    float Weight,
    const FVector4& WorldSpaceDirectio...
)

Adds an impulse to the SH environment.

Public function

void

 

ApplyWindowing

(
    float Lambda
)

Public function Const

bool

 

AreFloatsValid()

Public function Const

FLinearColor

 

CalcIntegral()

Calculates the integral of the function over the surface of the sphere.

Public function

void

 

Desaturate

(
    float DesaturateFraction
)

Public function Const

TSHVector< M...

 

GetLuminance()

Calculates greyscale spherical harmonic coefficients.

Operators

Name Description

Public function

TSHVectorRGB...

 

operator*=

(
    const float& Scalar
)

In-place scalar multiplication operator.

Public function

TSHVectorRGB...

 

operator+=

(
    const TSHVectorRGB& InB
)

In-place addition operator.

Public function

TSHVectorRGB...

 

operator-=

(
    const TSHVectorRGB& InB
)

In-place subtraction operator.

References

Module

Core

Header

Runtime/Core/Public/Math/SHMath.h

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