PointLight

Represents a light that emits from a single point in all directions.

A point light simulates a localized light source such as a bare lightbulb. Intensity falls off with distance according to the configured attenuation parameters.

auto point = vglx::PointLight::Create({
  .color = 0xFFFFFF,
  .intensity = 1.0f,
  .attenuation = {
    .base = 1.0f,
    .linear = 0.0f,
    .quadratic = 0.0f
  }
});

INFO

Derives from Light and inherits all public properties and methods.

Construction

Constructors

PointLight()

Constructs a point light.

PointLight::PointLight(const Parameters& params);

Parameter	Description
params	Initialization parameters for constructing the light.

Factories preferred

PointLight::Create() auto

Creates a shared instance of PointLight.

static auto PointLight::Create(const Parameters& params);

Parameter	Description
params	Initialization parameters for constructing the light.

Types

PointLight::Parameters struct

Parameters for constructing a PointLight object.

Parameter	Description
color Color	Light color.
intensity float	Light intensity multiplier.
attenuation Attenuation	Light attenuation parameters.

Properties

attenuation Attenuation

Attenuation parameters controlling distance-based falloff.

Attenuation attenuation {};

Functions

GetType() Light::Type virtual

Identifies this light as Light::Type::Point.

Type vglx::PointLight::GetType() const override;

OnUpdate() void virtual

Called once per frame to update the light state.

Currently used to update the debug geometry when debug mode is enabled.

void PointLight::OnUpdate(float delta) override;

Parameter	Description
delta	Time in seconds since the last frame.

SetDebugMode() void virtual

Enables or disables debug visualization for this light.

When enabled, the renderer will visualize the light’s location using a spherical line geometry.

void PointLight::SetDebugMode(bool is_debug_mode) override;

Parameter	Description
is_debug_mode	true to enable debug mode; false to disable.