Struct LightEnv

pub struct LightEnv { /* private fields */ }

Lighting environment, passed as one of the fragment stages.

A LightEnv is comprised of 8 different lights governed by the same lighting algorithm.

Implementations

impl LightEnv

pub fn new_pinned() -> Pin<Box<LightEnv>>

Constructs a new lighting environment.

Due to the internal representation of a lighting environment, the lighting environment and the various lights are all pinned objects.

pub fn set_material(self: Pin<&mut Self>, mat: Material)

Setup the environment material.

This material is inherited by all internal lights.

pub fn lights(&self) -> &PinArray<Option<Light>, NB_LIGHTS>

Returns a reference to the array of (pinned) lights.

pub fn lights_mut( self: Pin<&mut Self>, ) -> Pin<&mut PinArray<Option<Light>, NB_LIGHTS>>

Returns a mutable reference to the array of (pinned) lights.

pub fn light_mut( self: Pin<&mut Self>, idx: LightIndex, ) -> Option<Pin<&mut Light>>

Returns a mutable reference to the light at a particular index.

pub fn create_light(self: Pin<&mut Self>) -> Option<LightIndex>

Sets up a new light source and returns its index for use.

If no more light sources can be created, [None] is returned.

pub fn destroy_light(self: Pin<&mut Self>, idx: LightIndex)

Uninitalizes and disables the light at a specific index.

pub fn disconnect_lut( self: Pin<&mut Self>, id: LutId, input: LutInput, ) -> Option<Lut>

Attempts to disconnect a light lookup-table.

This function returns [None] if no LUT was connected for id and input. Otherwise, returns the disconnected LUT.

pub fn connect_lut(self: Pin<&mut Self>, id: LutId, input: LutInput, data: Lut)

Connects a light lookup-table at the given index, with a given input.

pub fn set_fresnel(self: Pin<&mut Self>, sel: FresnelSelector)

Sets the fresnel for the lighting environment.

pub fn as_raw(&self) -> &C3D_LightEnv

Returns a reference to the raw Citro3D representation.

pub fn as_raw_mut(self: Pin<&mut Self>) -> &mut C3D_LightEnv

Returns a mutable reference to the raw Citro3D representation.