Struct UnlitMaterial 

pub struct UnlitMaterial {
    pub auto_sync_texture_to_uniforms: bool,
    /* private fields */
}

Fields

auto_sync_texture_to_uniforms: bool

When true, texture transforms are automatically flushed to uniforms.

Implementations

impl UnlitMaterial

pub fn from_uniforms(uniforms: UnlitUniforms) -> UnlitMaterial

Creates a new material instance from uniform data with default settings.

pub fn settings_mut(&self) -> SettingsGuard<'_>

Returns a RAII guard for batch-modifying material settings.

The guard automatically increments the material version on drop if any settings changed, triggering pipeline cache invalidation.

pub fn settings(&self) -> MaterialSettings

Returns a snapshot of the current material settings.

pub fn set_alpha_mode(&self, mode: AlphaMode)

Sets the alpha blending mode.

pub fn alpha_mode(&self) -> AlphaMode

Returns the current alpha blending mode.

pub fn set_side(&self, side: Side)

Sets the face culling mode (Front/Back/Double).

pub fn side(&self) -> Side

Returns the current face culling mode.

pub fn set_depth_test(&self, depth_test: bool)

Enables or disables depth testing.

pub fn depth_test(&self) -> bool

Returns whether depth testing is enabled.

pub fn set_depth_write(&self, depth_write: bool)

Enables or disables depth buffer writing.

For transparent objects, it is usually recommended to disable this.

pub fn depth_write(&self) -> bool

Returns whether depth buffer writing is enabled.

pub fn uniforms_mut(&self) -> CheckedBufferGuard<'_, UnlitUniforms>

Returns a write guard for batch-modifying uniform parameters.

The guard automatically marks data as dirty on drop, triggering GPU buffer synchronization.

pub fn uniforms(&self) -> BufferReadGuard<'_, UnlitUniforms>

Returns a read guard for accessing uniform parameters.

pub fn set_color(&self, value: Vec4)

Base color.

pub fn color(&self) -> Vec4

Base color.

pub fn set_opacity(&self, value: f32)

Opacity value.

pub fn opacity(&self) -> f32

Opacity value.

pub fn set_alpha_test(&self, value: f32)

Alpha test threshold.

pub fn alpha_test(&self) -> f32

Alpha test threshold.

pub fn set_map(&self, value: Option<TextureHandle>)

The color map.

pub fn map(&self) -> Option<TextureHandle>

The color map.

pub fn set_map_transform(&self, transform: TextureTransform)

Sets the UV transform for this texture slot.

pub fn configure_map<F>(&self, f: F)

where F: FnOnce(&mut TextureSlot),

Configures this texture slot via a closure for batch modifications.

The closure receives a mutable reference to the [TextureSlot]. Version is automatically bumped if the texture or UV channel changes.

pub fn flush_texture_transforms(&self) -> bool

Flushes texture transform matrices to the uniform buffer.

Only writes when values actually change, avoiding unnecessary version bumps. Returns whether any data was updated.

pub fn configure<F>(&self, f: F)

where F: FnOnce(&UnlitUniforms),

Provides access to uniform data through a closure (under write lock).

pub fn notify_pipeline_dirty(&self)

Manually marks the material pipeline as dirty, forcing a rebuild.

In most cases this is not needed, as the standard API automatically tracks version changes. Use this only when:

• After directly modifying internal fields (e.g., in loader code)
• When material configuration has changed but version wasn’t updated

impl UnlitMaterial

pub fn new(color: Vec4) -> UnlitMaterial

Creates a new unlit material with the given base color.

pub fn with_color(self, color: Vec4) -> UnlitMaterial

Sets the base color (builder).

pub fn with_opacity(self, opacity: f32) -> UnlitMaterial

Sets the opacity (builder).

pub fn with_map(self, handle: TextureHandle) -> UnlitMaterial

Sets the color map texture (builder).

pub fn with_side(self, side: Side) -> UnlitMaterial

Sets the face culling side (builder).

pub fn with_alpha_mode(self, mode: AlphaMode) -> UnlitMaterial

Sets the alpha mode (builder).

pub fn with_depth_write(self, enabled: bool) -> UnlitMaterial

Sets depth write (builder).

Trait Implementations

impl Clone for UnlitMaterial

fn clone(&self) -> UnlitMaterial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnlitMaterial

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

Formats the value using the given formatter.

impl Default for UnlitMaterial

fn default() -> UnlitMaterial

Returns the “default value” for a type.

impl From<UnlitMaterial> for Material

fn from(data: UnlitMaterial) -> Material

Converts to this type from the input type.

impl MaterialTrait for UnlitMaterial

fn as_any(&self) -> &(dyn Any + 'static)

Returns self as Any for downcasting.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns mutable self as Any for downcasting.

impl RenderableMaterialTrait for UnlitMaterial

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

Returns the shader template name.

fn version(&self) -> u64

Returns the material version (used for cache invalidation).

fn settings(&self) -> MaterialSettings

Returns material rendering settings.

fn uniform_buffer(&self) -> BufferRef

Returns a reference to the uniform buffer.

fn with_uniform_bytes(&self, visitor: &mut dyn FnMut(&[u8]))

Provides uniform data bytes to the callback.

fn shader_defines(&self) -> ShaderDefines

Returns shader macro definitions based on current material state.

fn visit_textures(&self, visitor: &mut dyn FnMut(&TextureSource))

Visits all textures used by this material.

fn define_bindings<'a>(&'a self, builder: &mut ResourceBuilder<'a>)

Defines GPU resource bindings for this material.

fn extra_defines(&self, _defines: &mut ShaderDefines)

impl ResolveMaterial for UnlitMaterial

fn resolve(self, assets: &AssetServer) -> MaterialHandle