Struct Lightmap

pub struct Lightmap {
    pub map: FxHashMap<Handle<Node>, Vec<LightmapEntry>>,
    pub patches: FxHashMap<u64, SurfaceDataPatchWrapper>,
}

Lightmap is a texture with precomputed lighting.

Fields

map: FxHashMap<Handle<Node>, Vec<LightmapEntry>>

Node handle to lightmap mapping. It is used to quickly get information about lightmaps for any node in scene.

patches: FxHashMap<u64, SurfaceDataPatchWrapper>

List of surface data patches. Each patch will be applied to corresponding surface data on resolve stage.

Implementations

impl Lightmap

pub const MAP: &'static str = "map"

impl Lightmap

pub async fn load<P: AsRef<Path>>( path: P, resource_manager: ResourceManager, ) -> Result<Lightmap, VisitError>

Loads a light map from the given path.

pub fn save<P: AsRef<Path>>(&mut self, path: P) -> VisitResult

Saves a light map to the given file. Keep in mind, that the textures should be saved separately first, via Self::save_textures method.

pub fn new( data: LightmapInputData, texels_per_unit: u32, uv_spacing: f32, cancellation_token: CancellationToken, progress_indicator: ProgressIndicator, ) -> Result<Self, LightmapGenerationError>

Generates lightmap for given scene. This method automatically generates secondary texture coordinates! This method is blocking, however internally it uses massive parallelism to use all available CPU power efficiently.

texels_per_unit defines resolution of lightmap, the higher value is, the more quality lightmap will be generated, but also it will be slow to generate. progress_indicator allows you to get info about current progress. cancellation_token allows you to stop generation in any time.

pub fn save_textures<P: AsRef<Path>>( &self, base_path: P, resource_manager: ResourceManager, ) -> Result<(), ResourceRegistrationError>

Saves lightmap textures into specified folder.

Trait Implementations

impl Clone for Lightmap

fn clone(&self) -> Lightmap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lightmap

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

Formats the value using the given formatter.

impl Default for Lightmap

fn default() -> Lightmap

Returns the “default value” for a type.

impl Reflect for Lightmap

where Self: 'static, FxHashMap<Handle<Node>, Vec<LightmapEntry>>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for Lightmap

where FxHashMap<Handle<Node>, Vec<LightmapEntry>>: Visit, FxHashMap<u64, SurfaceDataPatchWrapper>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.