Struct KittyConfig 

pub struct KittyConfig {
    pub virtual_size: UVec2,
    pub mode: KittyMode,
    pub text_scale: f32,
    pub terminal_size: Option<TermSize>,
    pub text: bool,
    pub ui: bool,
    pub input: bool,
    pub pixel_source: Arc<dyn PixelSource>,
}

How the renderer is configured. Inserted as a resource by KittyPlugin, so systems can read it.

Fields

virtual_size: UVec2

The virtual resolution your game draws at, e.g. 320x180. Everything is scaled and letterboxed from this, preserving aspect.

This is the crate’s replacement for a game’s own resolution constants.

mode: KittyMode

Which render strategy to use.

text_scale: f32

Rasterise text at this multiple of the virtual resolution, so small fonts are not upscaled blobs.

A game drawing at 320x180 authors fonts at 4 to 10 px. At 1.0 a letter is a roughly 5x7 pixel blob, and upscaling cannot add detail. Raising this sets the render target’s scale_factor, which makes Bevy rasterise glyphs larger in the first place.

The subtlety, handled for you: logical_size = physical_size / scale_factor, so raising the scale factor alone would shrink the logical viewport and break every coordinate. The target’s pixel size is scaled by the same factor, keeping the logical viewport at exactly virtual_size.

Clamped to 1.0..=16.0. Ignored in frame mode, which reads the target back expecting exactly virtual_size.

terminal_size: Option<TermSize>

None asks the terminal how big it is. Set it when stdout is a pipe (no tty to query) or to pin a size for testing.

text: bool

Render Text2d as reusable glyph images. Needs the text feature.

This also covers bevy_ui’s Text widget, which populates the same TextLayoutInfo and the same font atlas, so UI labels come out of the same pass at no extra cost.

ui: bool

Render bevy_ui nodes: backgrounds, borders, outlines and images. Needs the ui feature.

Turn it off for a game that draws entirely in world space, which saves the pass walking a node tree that is always empty.

input: bool

Read mouse and keyboard from the terminal. Needs the input feature.

Turn this off when stdout is redirected to a file: raw mode on a non-terminal is meaningless, and the reader thread would compete for stdin.

pixel_source: Arc<dyn PixelSource>

Where sprite pixels come from. Defaults to pixels::DiskPixels, which reproduces Bevy’s default asset layout.

The indirection exists because pixels cannot simply come from the ECS: Bevy frees a sprite image’s CPU-side copy once it is uploaded to the GPU, so Assets<Image> is usually empty for ordinary sprites. The font atlas is the exception, because Bevy keeps that CPU-persistent on purpose.

Trait Implementations

impl Clone for KittyConfig

fn clone(&self) -> KittyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for KittyConfig

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for KittyConfig

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

Formats the value using the given formatter.

impl Default for KittyConfig

fn default() -> Self

Returns the “default value” for a type.

impl Resource for KittyConfig

where Self: Send + Sync + 'static,