Skip to main content

TextRenderer

Struct TextRenderer 

Source
pub struct TextRenderer { /* private fields */ }
Expand description

A text renderer that uses cached glyphs to render text into an existing render pass.

Implementations§

Source§

impl TextRenderer

Source

pub fn new( atlas: &mut TextAtlas, device: &Device, multisample: MultisampleState, depth_stencil: Option<DepthStencilState>, ) -> Self

Creates a new TextRenderer.

Source

pub fn prepare_with_depth<'a>( &mut self, device: &Device, queue: &Queue, encoder: &mut CommandEncoder, font_system: &mut FontSystem, atlas: &mut TextAtlas, viewport: &Viewport, text_areas: impl IntoIterator<Item = TextArea<'a>>, cache: &mut SwashCache, metadata_to_depth: impl FnMut(usize) -> f32, ) -> Result<(), PrepareError>

Prepares all of the provided text areas for rendering.

Source

pub fn prepare<'a>( &mut self, device: &Device, queue: &Queue, encoder: &mut CommandEncoder, font_system: &mut FontSystem, atlas: &mut TextAtlas, viewport: &Viewport, text_areas: impl IntoIterator<Item = TextArea<'a>>, cache: &mut SwashCache, ) -> Result<(), PrepareError>

Source

pub fn render( &self, atlas: &TextAtlas, viewport: &Viewport, pass: &mut RenderPass<'_>, ) -> Result<(), RenderError>

Renders all layouts that were previously provided to prepare.

Auto Trait Implementations§

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> 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, 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.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,