Struct bevy_ascii_terminal::renderer::material::TerminalMaterial

pub struct TerminalMaterial {
    pub clip_color: Color,
    pub texture: Option<Handle<Image>>,
}

The material for rendering a terminal.

Fields

clip_color: Color

The clip color for the active font texture.

Clip color determines which part of the texture is regarded as “background color”.

texture: Option<Handle<Image>>

The font texture rendered by the terminal.

Trait Implementations

impl Clone for TerminalMaterial

fn clone(&self) -> TerminalMaterial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalMaterial

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

Formats the value using the given formatter.

impl Default for TerminalMaterial

fn default() -> Self

Returns the “default value” for a type.

impl From<Handle<Image>> for TerminalMaterial

fn from(texture: Handle<Image>) -> Self

Converts to this type from the input type.

impl RenderAsset for TerminalMaterial

type ExtractedAsset = TerminalMaterial

The representation of the the asset in the “render world”.

type PreparedAsset = GpuTerminalMaterial

The GPU-representation of the the asset.

type Param = (Res<'static, RenderDevice>, Res<'static, Material2dPipeline<TerminalMaterial>>, Res<'static, HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>>)

Specifies all ECS data required by [RenderAsset::prepare_asset]. For convenience use the lifetimeless [SystemParam].

fn extract_asset(&self) -> Self::ExtractedAsset

Converts the asset into a [RenderAsset::ExtractedAsset].

fn prepare_asset(
    material: Self::ExtractedAsset,
    (render_device, pipeline, gpu_images): &mut SystemParamItem<'_, '_, Self::Param>
) -> Result<Self::PreparedAsset, PrepareAssetError<Self::ExtractedAsset>>

Prepares the extracted asset for the GPU by transforming it into a [RenderAsset::PreparedAsset]. Therefore ECS data may be accessed via the param.

impl SpecializedMaterial2d for TerminalMaterial

fn fragment_shader(_asset_server: &AssetServer) -> Option<Handle<Shader>>

Returns this material’s fragment shader. If None is returned, the default mesh fragment shader will be used. Defaults to None.

fn vertex_shader(_asset_server: &AssetServer) -> Option<Handle<Shader>>

Returns this material’s vertex shader. If None is returned, the default mesh vertex shader will be used. Defaults to None.

fn bind_group(render_asset: &<Self as RenderAsset>::PreparedAsset) -> &BindGroup

Returns this material’s [BindGroup]. This should match the layout returned by [SpecializedMaterial2d::bind_group_layout].

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

Returns this material’s [BindGroupLayout]. This should match the [BindGroup] returned by [SpecializedMaterial2d::bind_group].

type Key = ()

The key used to specialize this material’s [RenderPipelineDescriptor].

fn key(
    _render_devicec: &RenderDevice,
    _material: &<Self as RenderAsset>::PreparedAsset
) -> Self::Key

Extract the [SpecializedMaterial2d::Key] for the “prepared” version of this material. This key will be passed in to the [SpecializedMaterial2d::specialize] function when compiling the RenderPipeline for a given entity’s material.

fn specialize(
    _key: Self::Key,
    descriptor: &mut RenderPipelineDescriptor,
    _layout: &MeshVertexBufferLayout
) -> Result<(), SpecializedMeshPipelineError>

Specializes the given descriptor according to the given key.

fn dynamic_uniform_indices(material: &Self::PreparedAsset) -> &[u32]

The dynamic uniform indices to set for the given material’s [BindGroup]. Defaults to an empty array / no dynamic uniform indices.

impl TypeUuid for TerminalMaterial

const TYPE_UUID: Uuid = bevy::reflect::Uuid::from_bytes([226, 40, 165, 52, 227, 202, 46, 30, 171, 157, 77, 139, 193, 173, 140, 25])