Light

Struct Light 

Source
pub struct Light {
    pub light_type: LightType,
    pub enabled: bool,
}
Expand description

A component that adds a light source to an entity.

This component works in conjunction with the entity’s GlobalTransform to determine the light’s world-space position and orientation.

§Examples

use khora_data::ecs::components::Light;
use khora_core::renderer::light::{LightType, DirectionalLight};

// Create a sun light
let sun_light = Light {
    light_type: LightType::Directional(DirectionalLight::default()),
    enabled: true,
};

Fields§

§light_type: LightType

The type and properties of the light source.

§enabled: bool

Whether the light is currently active.

Disabled lights are not extracted for rendering and have no performance impact on the scene.

Implementations§

Source§

impl Light

Source

pub fn new(light_type: LightType) -> Self

Creates a new enabled light with the given type.

Source

pub fn directional() -> Self

Creates a new directional light (sun-like).

Source

pub fn point() -> Self

Creates a new point light.

Source

pub fn spot() -> Self

Creates a new spot light.

Trait Implementations§

Source§

impl Clone for Light

Source§

fn clone(&self) -> Light

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Light

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Light

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Component for Light

Auto Trait Implementations§

§

impl Freeze for Light

§

impl RefUnwindSafe for Light

§

impl Send for Light

§

impl Sync for Light

§

impl Unpin for Light

§

impl UnwindSafe for Light

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<C1> ComponentBundle for C1
where C1: Component,

Source§

fn type_ids() -> Vec<TypeId>

Returns the sorted list of TypeIds for the components in this bundle. Read more
Source§

fn create_columns() -> HashMap<TypeId, Box<dyn AnyVec>>

Creates the set of empty, type-erased Vec<T> columns required to store this bundle’s components. Read more
Source§

fn update_metadata( metadata: &mut EntityMetadata, location: PageIndex, registry: &ComponentRegistry, )

Updates the appropriate fields in an EntityMetadata struct to point to the location of this bundle’s data. Read more
Source§

unsafe fn add_to_page(self, page: &mut ComponentPage)

Adds the components from this bundle into the specified ComponentPage. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.