Cryoglyph

https://docs.rs/cryoglyph/0.1.0/cryoglyph/
Admin
Cryoglyph is a Rust crate that provides a simple way to render 2D text with wgpu, cosmic-text, and...
Tokens:6,313
Snippets:80
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Viewport Resolution

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Retrieves the current Resolution of the Viewport.

```rust
pub fn resolution(&self) -> Resolution
```

--------------------------------

### Get Type ID

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the Any trait, providing a method to get the TypeId of the instance. This is part of blanket implementations.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Initialize Viewport

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Creates a new Viewport instance. Requires a Device and a Cache object.

```rust
pub fn new(device: &Device, cache: &Cache) -> Self
```

--------------------------------

### Render Prepared Text Layouts

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Renders all text layouts that have been previously prepared using the `prepare` or `prepare_with_depth` methods. Requires immutable access to self and the TextAtlas, along with the viewport and a mutable RenderPass.

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

--------------------------------

### Create New Cache Instance

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Constructs a new instance of the Cache. Requires a reference to a Device.

```rust
pub fn new(device: &Device) -> Self
```

--------------------------------

### TextAtlas Constructor Methods

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Methods for initializing a new TextAtlas instance, including support for custom color modes.

```APIDOC
## pub fn new(device: &Device, queue: &Queue, cache: &Cache, format: TextureFormat) -> Self

### Description
Creates a new TextAtlas instance using the provided device, queue, cache, and texture format.

### Parameters
- **device** (&Device) - Required - The graphics device.
- **queue** (&Queue) - Required - The graphics queue.
- **cache** (&Cache) - Required - The glyph cache.
- **format** (TextureFormat) - Required - The texture format for the atlas.

## pub fn with_color_mode(device: &Device, queue: &Queue, cache: &Cache, format: TextureFormat, color_mode: ColorMode) -> Self

### Description
Creates a new TextAtlas instance with a specific ColorMode.

### Parameters
- **device** (&Device) - Required - The graphics device.
- **queue** (&Queue) - Required - The graphics queue.
- **cache** (&Cache) - Required - The glyph cache.
- **format** (TextureFormat) - Required - The texture format for the atlas.
- **color_mode** (ColorMode) - Required - The color mode configuration.
```

--------------------------------

### Prepare Text Areas with Depth

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Prepares all provided text areas for rendering, including depth information. This method requires mutable access to self, device, queue, encoder, font_system, atlas, and cache. It also takes a viewport and an iterator of text areas, along with a closure to map metadata to depth.

```rust
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>
```

--------------------------------

### Implement Equivalent for Q

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Checks if a value is equivalent to a given key, often used in collections like HashMap.

```rust
fn equivalent(&self, key: &K) -> bool
```

--------------------------------

### TextRenderer Methods

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Methods for initializing and using the TextRenderer to render text.

```APIDOC
## TextRenderer::new

### Description
Creates a new instance of TextRenderer.

### Parameters
- **atlas** (&mut TextAtlas) - Required - The text atlas to use.
- **device** (&Device) - Required - The graphics device.
- **multisample** (MultisampleState) - Required - Multisample state configuration.
- **depth_stencil** (Option<DepthStencilState>) - Required - Optional depth stencil state.

## TextRenderer::prepare

### Description
Prepares all of the provided text areas for rendering.

### Parameters
- **device** (&Device) - Required - The graphics device.
- **queue** (&Queue) - Required - The graphics queue.
- **encoder** (&mut CommandEncoder) - Required - The command encoder.
- **font_system** (&mut FontSystem) - Required - The font system.
- **atlas** (&mut TextAtlas) - Required - The text atlas.
- **viewport** (&Viewport) - Required - The viewport configuration.
- **text_areas** (impl IntoIterator<Item = TextArea<'a>>) - Required - The text areas to prepare.
- **cache** (&mut SwashCache) - Required - The swash cache.

## TextRenderer::render

### Description
Renders all layouts that were previously provided to prepare.

### Parameters
- **atlas** (&TextAtlas) - Required - The text atlas.
- **viewport** (&Viewport) - Required - The viewport configuration.
- **pass** (&mut RenderPass<'_>) - Required - The render pass to draw into.
```

--------------------------------

### Create New TextRenderer

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Initializes a new TextRenderer instance. Requires a mutable TextAtlas, a Device, MultisampleState, and an optional DepthStencilState.

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

--------------------------------

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Experimental nightly-only API for performing copy-assignment from self to uninitialized memory.

```rust
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
```

--------------------------------

### Prepare Text Areas for Rendering

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Prepares text areas for rendering without explicit depth mapping. Requires mutable access to self and other rendering resources like device, queue, encoder, font_system, atlas, and cache.

```rust
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>
```

--------------------------------

### Implement PartialEq for TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Allows comparing two TextBounds instances for equality. This is used by the `==` operator.

```rust
fn eq(&self, other: &TextBounds) -> bool
```

--------------------------------

### Create New TextAtlas

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Creates a new TextAtlas instance. Requires a device, queue, cache, and texture format.

```rust
pub fn new( device: &Device, queue: &Queue, cache: &Cache, format: TextureFormat, ) -> Self
```

--------------------------------

### Cache Constructor

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Provides a way to create a new instance of the Cache struct.

```APIDOC
## Implementations

### impl Cache

#### pub fn new(device: &Device) -> Self

Creates a new Cache instance associated with the given device.
```

--------------------------------

### Resolution Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Resolution.html

Represents the screen resolution to use when rendering text.

```APIDOC
## Struct Resolution

### Description
The screen resolution to use when rendering text.

### Fields
- **width** (u32) - The width of the screen in pixels.
- **height** (u32) - The height of the screen in pixels.

### Trait Implementations
- **Clone**: Allows creating copies of the Resolution struct.
- **Debug**: Enables debugging output for the Resolution struct.
- **PartialEq**: Allows comparing two Resolution structs for equality.
- **Copy**: Indicates that the struct can be copied implicitly.
- **Eq**: Marks the struct as having a total equivalence relation.
- **StructuralPartialEq**: Enables structural comparison for equality.

### Auto Trait Implementations
- **Freeze**, **RefUnwindSafe**, **Send**, **Sync**, **Unpin**, **UnwindSafe**
```

--------------------------------

### Viewport API

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Methods for managing the Viewport lifecycle and resolution state.

```APIDOC
## Viewport Struct

### Description
The Viewport struct represents the rendering area. It is initialized with device and cache references and allows for dynamic resolution updates.

### Methods

#### new(device: &Device, cache: &Cache) -> Self
Creates a new instance of the Viewport.

#### update(&mut self, queue: &Queue, resolution: Resolution)
Updates the viewport with a new resolution using the provided queue.

#### resolution(&self) -> Resolution
Returns the current resolution of the viewport.
```

--------------------------------

### Create TextAtlas with ColorMode

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Creates a new TextAtlas instance with a specified ColorMode. Requires device, queue, cache, and texture format.

```rust
pub fn with_color_mode( device: &Device, queue: &Queue, cache: &Cache, format: TextureFormat, color_mode: ColorMode, ) -> Self
```

--------------------------------

### Clone Implementation for TextArea

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Provides functionality to create a duplicate of a TextArea instance.

```rust
impl<'a> Clone for TextArea<'a>
Source§
#### fn clone(&self) -> TextArea<'a>
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
```

--------------------------------

### try_into Conversion

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

Performs a fallible conversion from one type to another.

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

### Description
Performs the conversion from the current type to the target type U.

### Returns
- **Result<U, <U as TryFrom<T>>::Error>** - The result of the conversion.
```

--------------------------------

### try_into Conversion

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.RenderError.html

Performs a conversion from the current type to a target type U.

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

### Description
Performs the conversion from the current type to a target type U.

### Parameters
- **self** - Required - The instance to convert.
```

--------------------------------

### Cache Trait Implementations

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Details the various traits implemented for the Cache struct, such as Clone, Debug, and others.

```APIDOC
## Trait Implementations

### impl Clone for Cache

#### fn clone(&self) -> Cache
Returns a duplicate of the value.

#### fn clone_from(&mut self, source: &Self)
Performs copy-assignment from `source`.

### impl Debug for Cache

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.

### impl Freeze for Cache

### impl !RefUnwindSafe for Cache

### impl Send for Cache

### impl Sync for Cache

### impl Unpin for Cache

### impl !UnwindSafe for Cache

### impl<T> Any for T

#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T

#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T

#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> CloneToUninit for T

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`.

### impl<T> From<T> for T

#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T

#### fn into(self) -> U
Calls `U::from(self)`.

### impl<T> ToOwned for T

#### type Owned = T

#### fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning.

#### fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning.

### impl<T, U> TryFrom<U> for T

#### type Error = Infallible

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

### impl<T, U> TryInto<U> for T

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

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

### impl<T> WasmNotSend for T

### impl<T> WasmNotSendSync for T

### impl<T> WasmNotSync for T

```

--------------------------------

### Implement Default for TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Provides a default value for TextBounds, which represents an area that does not clip any text. This is useful for initializing bounds when no specific clipping is required.

```rust
fn default() -> Self
```

--------------------------------

### Clone to Uninitialized Memory (Nightly Only)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Performs copy-assignment from self to uninitialized memory at the given destination pointer. This is a nightly-only experimental API.

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

--------------------------------

### Define TextArea Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Defines the structure for a text area, holding text buffer, position, scale, bounds, and default color.

```rust
pub struct TextArea<'a> {
    pub buffer: &'a Buffer,
    pub left: f32,
    pub top: f32,
    pub scale: f32,
    pub bounds: TextBounds,
    pub default_color: Color,
}
```

--------------------------------

### TextAtlas Utility Methods

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Utility methods for managing the state of the TextAtlas.

```APIDOC
## pub fn trim(&mut self)

### Description
Trims the TextAtlas, likely to free up unused memory or optimize the cache.
```

--------------------------------

### Implement Ne for TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Allows comparing two TextBounds instances for inequality. This is used by the `!=` operator.

```rust
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### Implement Clone for TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Allows creating a duplicate of a TextBounds instance. This is a standard trait for types that can be copied.

```rust
fn clone(&self) -> TextBounds
```

--------------------------------

### Clone From Cache Instance

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Performs copy-assignment from a source Cache instance to the current one. This is part of the Clone trait.

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

--------------------------------

### PrepareError Trait Implementations

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

This section details the various trait implementations for the PrepareError enum, showcasing its compatibility with standard Rust error handling and debugging mechanisms.

```APIDOC
### Trait Implementations for PrepareError

#### `Clone`
Allows creating a copy of a `PrepareError` instance.

#### `Debug`
Enables formatted output for debugging purposes.

#### `Display`
Provides a user-friendly string representation of the error.

#### `Error`
Implements the standard Rust `Error` trait, allowing `PrepareError` to be used in error handling chains. Includes methods like `source()` for accessing underlying errors (though `PrepareError` does not have underlying errors).

#### `PartialEq`
Enables comparison of `PrepareError` instances for equality.

#### `Copy`
Indicates that `PrepareError` can be copied implicitly.

#### `Eq`
Marks `PrepareError` as having a total equivalence relation.

#### `StructuralPartialEq`
Enables structural equality comparisons.
```

--------------------------------

### Implement Copy for TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Indicates that TextBounds can be copied by simply copying its bits. This is a marker trait implying that the type is implicitly cloneable and does not require manual cloning.

--------------------------------

### Declare Viewport Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Defines the Viewport struct. It has private fields and is intended for internal use.

```rust
pub struct Viewport { /* private fields */ }
```

--------------------------------

### Format Viewport for Debugging

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the Debug trait for Viewport, allowing it to be formatted for debugging purposes.

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

--------------------------------

### From Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Allows conversion from a type to itself, returning the argument unchanged.

```rust
impl<T> From<T> for T
Source§
#### fn from(t: T) -> T
Returns the argument unchanged.
```

--------------------------------

### Try Conversion (TryInto)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the TryInto trait for fallible conversions. The Error type is derived from the corresponding TryFrom implementation.

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

--------------------------------

### Try Conversion (TryFrom)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the TryFrom trait for fallible conversions. The Error type is Infallible, indicating no errors are expected.

```rust
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

--------------------------------

### Into Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Enables conversion to another type if a corresponding From implementation exists.

```rust
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.
```

--------------------------------

### Define TextBounds Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Defines the structure for text bounds, specifying the visible area for text clipping. The fields represent the coordinates of the visible area's edges.

```rust
pub struct TextBounds {
    pub left: i32,
    pub top: i32,
    pub right: i32,
    pub bottom: i32,
}
```

--------------------------------

### Clone Cache Instance

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Returns a duplicate of the Cache value. This implementation is part of the Clone trait.

```rust
fn clone(&self) -> Cache
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Provides the type_id method for any type that is 'static and ?Sized.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
Source§
#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`. Read more
```

--------------------------------

### Update Viewport Resolution

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Updates the Viewport's resolution. This method requires a mutable reference to the Viewport, a Queue, and the new Resolution.

```rust
pub fn update(&mut self, queue: &Queue, resolution: Resolution)
```

--------------------------------

### Identity Conversion (From)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the From trait for identity conversion, returning the argument unchanged. This is part of blanket implementations.

```rust
fn from(t: T) -> T
```

--------------------------------

### Try Convert From Target Type

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Attempts to perform a conversion from a target type `U` into the current type `T`. Returns a `Result` indicating success or failure. This is part of the `TryFrom<U>` trait implementation.

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

--------------------------------

### TryFrom Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Enables fallible conversion from one type to another, returning a Result.

```rust
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.
```

--------------------------------

### Create Owned Data from Borrowed Data

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Creates owned data from borrowed data, usually by cloning. This is a blanket implementation for any type T.

```rust
fn to_owned(&self) -> T
```

--------------------------------

### Identity Conversion (Into)

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the Into trait for identity conversion, calling U::from(self). This is part of blanket implementations.

```rust
fn into(self) -> U
```

--------------------------------

### Try Convert Into Target Type

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Attempts to convert the current type `T` into a target type `U` that implements `TryFrom<T>`. Returns a `Result` indicating success or failure. This is part of the `TryInto<U>` trait implementation.

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

--------------------------------

### Clone into Existing Owned Data

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Uses borrowed data to replace owned data, usually by cloning. This is a blanket implementation for any type T.

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

--------------------------------

### Define Resolution struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Resolution.html

The Resolution struct is used to specify the screen dimensions in pixels for rendering operations.

```rust
#[repr(C)]
pub struct Resolution {
    pub width: u32,
    pub height: u32,
}
```

--------------------------------

### Cache Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Represents the Cache struct in the cryoglyph library. It is used for caching operations.

```APIDOC
## Struct Cache

### Summary
```rust
pub struct Cache(/* private fields */);
```
```

--------------------------------

### TryInto Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Enables fallible conversion to another type, returning a Result.

```rust
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.
```

--------------------------------

### Define TextRenderer Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextRenderer.html

Defines the TextRenderer struct, which is used for rendering text with cached glyphs. It has private fields.

```rust
pub struct TextRenderer { /* private fields */ }
```

--------------------------------

### Define Cache Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Cache.html

Defines the Cache struct. It contains private fields and is used for caching operations.

```rust
pub struct Cache(/* private fields */);
```

--------------------------------

### Implement ToOwned for T

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

Provides a way to create an owned version of a borrowed type, typically by cloning. This is useful when you need ownership from a reference.

```rust
type Owned = T
```

```rust
fn to_owned(&self) -> T
```

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

--------------------------------

### Struct: TextBounds

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextBounds.html

The TextBounds struct defines the rectangular boundaries used to clip text. It consists of four i32 fields representing the edges of the visible area.

```APIDOC
## Struct TextBounds

### Description
Controls the visible area of the text. Any text outside of the visible area will be clipped.

### Fields
- **left** (i32) - The position of the left edge of the visible area.
- **top** (i32) - The position of the top edge of the visible area.
- **right** (i32) - The position of the right edge of the visible area.
- **bottom** (i32) - The position of the bottom edge of the visible area.

### Implementation Details
- **Default**: The default visible area does not clip any text.
- **Traits**: Implements Clone, Debug, Default, PartialEq, Eq, Copy, and StructuralPartialEq.
```

--------------------------------

### ColorMode Enum

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.ColorMode.html

Defines the available color management modes for an Atlas.

```APIDOC
## Enum ColorMode

### Description
The color mode of an `Atlas`. This determines how colored glyphs are processed and blended during rendering.

### Variants
- **Accurate**: Uses a proper sRGB texture for colored glyphs, resulting in physically accurate color blending.
- **Web**: Reproduces the color management strategy used in web browsers, storing sRGB colors in a linear RGB texture. This is compatible with most UI toolkits but is not physically accurate.
```

--------------------------------

### Borrow Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Provides immutable borrowing functionality for any type.

```rust
impl<T> Borrow<T> for T
where T: ?Sized,
Source§
#### fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
```

--------------------------------

### BorrowMut Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Provides mutable borrowing functionality for any type.

```rust
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
```

--------------------------------

### Struct TextArea

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

The TextArea struct represents a text area containing text to be rendered along with its overflow behavior.

```APIDOC
## Struct TextArea

### Description
A text area containing text to be rendered along with its overflow behavior.

### Fields
- **buffer** (&'a Buffer) - The buffer containing the text to be rendered.
- **left** (f32) - The left edge of the buffer.
- **top** (f32) - The top edge of the buffer.
- **scale** (f32) - The scaling to apply to the buffer.
- **bounds** (TextBounds) - The visible bounds of the text area. This is used to clip the text and doesn’t have to match the left and top values.
- **default_color** (Color) - The default color for the text.
```

--------------------------------

### Define PrepareError Enum

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

The structure of the PrepareError enum used for handling text preparation errors.

```rust
pub enum PrepareError {
    AtlasFull,
}
```

--------------------------------

### Mutable Borrow

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the BorrowMut trait, allowing mutable borrowing of the owned value. This is part of blanket implementations.

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

--------------------------------

### Trim TextAtlas Cache

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Trims the cache of the TextAtlas. This method modifies the TextAtlas in place.

```rust
pub fn trim(&mut self)
```

--------------------------------

### Immutable Borrow

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.Viewport.html

Implements the Borrow trait, allowing immutable borrowing of the owned value. This is part of blanket implementations.

```rust
fn borrow(&self) -> &T
```

--------------------------------

### PrepareError Enum

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

The PrepareError enum represents errors that can occur during the text preparation phase for rendering. It currently has one variant: AtlasFull.

```APIDOC
## Enum PrepareError

### Description
An error that occurred while preparing text for rendering.

### Variants

#### AtlasFull
Represents the case where the texture atlas is full and cannot accommodate new text glyphs.
```

--------------------------------

### WasmNotSync Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.RenderError.html

Implementation of WasmNotSync for types that implement Sync.

```APIDOC
## impl<T> WasmNotSync for T

### Description
Implementation for types T where T: Sync.
```

--------------------------------

### WasmNotSync Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

Implementation of WasmNotSync for types that implement Sync.

```APIDOC
## impl<T> WasmNotSync for T

### Description
Implements WasmNotSync for any type T that implements Sync.
```

--------------------------------

### Define TextAtlas Struct

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextAtlas.html

Defines the TextAtlas struct, which holds a cache of rasterized glyphs for rendering.

```rust
pub struct TextAtlas { /* private fields */ }
```

--------------------------------

### ToOwned Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Provides methods to create owned data from borrowed data, typically by cloning.

```rust
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
```

--------------------------------

### WasmNotSendSync Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.RenderError.html

Implementation of WasmNotSendSync for types that are both WasmNotSend and WasmNotSync.

```APIDOC
## impl<T> WasmNotSendSync for T

### Description
Implementation for types T where T: WasmNotSend + WasmNotSync.
```

--------------------------------

### WasmNotSendSync Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

Implementation of WasmNotSendSync for types that are both WasmNotSend and WasmNotSync.

```APIDOC
## impl<T> WasmNotSendSync for T

### Description
Implements WasmNotSendSync for any type T that implements both WasmNotSend and WasmNotSync.
```

--------------------------------

### RenderError Enum

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.RenderError.html

The RenderError enum provides variants to handle specific rendering failure states.

```APIDOC
## RenderError

### Description
An error that occurred while rendering text.

### Variants
- **RemovedFromAtlas** - Indicates the resource was removed from the atlas.
- **ScreenResolutionChanged** - Indicates the screen resolution has changed, invalidating current render state.
```

--------------------------------

### WasmNotSync Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Marks a type as not safe for concurrent access across WebAssembly boundaries if it implements Sync.

```rust
impl<T> WasmNotSync for T
where T: Sync,
Source§
```

--------------------------------

### Define ColorMode Enum

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.ColorMode.html

The ColorMode enum specifies the color management strategy for an Atlas.

```rust
pub enum ColorMode {
    Accurate,
    Web,
}
```

--------------------------------

### WasmNotSendSync Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Marks a type as not safe for concurrent access or sending across WebAssembly boundaries.

```rust
impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,
Source§
```

--------------------------------

### WasmNotSend Trait Implementation

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/struct.TextArea.html

Marks a type as not safe to send across WebAssembly boundaries if it implements Send.

```rust
impl<T> WasmNotSend for T
where T: Send,
Source§
```

--------------------------------

### WasmNotSend Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.RenderError.html

Implementation of WasmNotSend for types that implement Send.

```APIDOC
## impl<T> WasmNotSend for T

### Description
Implementation for types T where T: Send.
```

--------------------------------

### WasmNotSend Trait

Source: https://docs.rs/cryoglyph/0.1.0/cryoglyph/enum.PrepareError.html

Implementation of WasmNotSend for types that implement Send.

```APIDOC
## impl<T> WasmNotSend for T

### Description
Implements WasmNotSend for any type T that implements Send.
```
Tokens:
Raw