Lib.rs

Cargo Features

bevy_internal has no features set by default.

[dependencies]
bevy_internal = { version = "0.17.1", features = ["trace", "trace_chrome", "trace_tracy", "trace_tracy_memory", "detailed_trace", "sysinfo_plugin", "compressed_image_saver", "zlib", "zstd", "zstd_rust", "zstd_c", "basis-universal", "bmp", "ff", "gif", "ico", "jpeg", "png", "pnm", "qoi", "tga", "tiff", "webp", "dds", "exr", "hdr", "ktx2", "spirv_shader_passthrough", "statically-linked-dxc", "raw_vulkan_init", "tonemapping_luts", "smaa_luts", "bluenoise_texture", "dlss", "force_disable_dlss", "flac", "mp3", "vorbis", "wav", "symphonia-aac", "symphonia-all", "symphonia-flac", "symphonia-isomp4", "symphonia-vorbis", "symphonia-wav", "shader_format_glsl", "shader_format_spirv", "shader_format_wesl", "serialize", "multi_threaded", "async-io", "wayland", "x11", "android-native-activity", "android-game-activity", "pbr_transmission_textures", "pbr_clustered_decals", "pbr_light_textures", "pbr_multi_layer_material_textures", "pbr_anisotropy_texture", "experimental_pbr_pcss", "pbr_specular_textures", "webgl", "webgpu", "bevy_ci_testing", "animation", "bevy_shader", "bevy_image", "bevy_sprite", "bevy_text", "bevy_ui", "bevy_mesh", "bevy_window", "bevy_winit", "bevy_camera", "bevy_scene", "bevy_light", "bevy_render", "bevy_core_pipeline", "bevy_anti_alias", "bevy_post_process", "bevy_pbr", "bevy_sprite_render", "bevy_ui_render", "bevy_solari", "bevy_gizmos", "bevy_gltf", "dynamic_linking", "android_shared_stdcxx", "accesskit_unix", "glam_assert", "debug_glam_assert", "default_font", "http", "https", "web_asset_cache", "asset_processor", "file_watcher", "embedded_watcher", "bevy_debug_stepping", "meshlet", "meshlet_processor", "bevy_dev_tools", "bevy_remote", "bevy_picking", "bevy_mesh_picking_backend", "bevy_sprite_picking_backend", "bevy_ui_picking_backend", "bevy_ui_debug", "bevy_state", "track_location", "reflect_functions", "reflect_auto_register", "reflect_auto_register_static", "reflect_documentation", "custom_cursor", "ghost_nodes", "std", "critical-section", "libm", "async_executor", "web", "hotpatching", "debug", "bevy_ui_widgets", "bevy_gilrs", "bevy_feathers", "bevy_input_focus"] }

trace trace_tracy_memory?

Enables trace of bevy_log, optional bevy_pbr, optional bevy_render, and optional bevy_winit

bevy_log:

bevy (std required)

and trace of bevy_app, bevy_ecs, optional bevy_anti_alias, optional bevy_asset, and optional bevy_core_pipeline

bevy_app:

bevy (no_std)

trace_chrome

Enables tracing-chrome of bevy_log

trace_tracy trace_tracy_memory?

Enables tracing-tracy of bevy_log and optional bevy_render

trace_tracy_memory = trace, trace_tracy

Enables trace_tracy_memory of bevy_log

detailed_trace

Enables detailed_trace of bevy_ecs and optional bevy_render

bevy_ecs:

Enables a more detailed set of traces which may be noisy if left on by default.

sysinfo_plugin

Enables sysinfo_plugin of bevy_diagnostic

bevy_diagnostic:

Adds integration with sysinfo.

compressed_image_saver

Enables compressed KTX2 UASTC texture output on the asset processor

Enables compressed_image_saver of bevy_image

zlib

For ktx2 supercompression

Enables zlib of bevy_image

zstd

Enables zstd of bevy_image

bevy_image:

A marker feature indicating zstd support is required for a particular feature.
A backend must be chosen by enabling either the "zstd_rust" or the "zstd_c" feature.

zstd_rust

Enables zstd_rust of bevy_image

bevy_image:

Pure-rust zstd implementation (safer)

zstd_c

Enables zstd_c of bevy_image

bevy_image:

Binding to zstd C implementation (faster)

basis-universal

Image format support (HDR and PNG enabled by default)

Enables basis-universal of bevy_image

bmp

Enables bmp of bevy_image

ff

Enables ff of bevy_image

gif

Enables gif of bevy_image

ico

Enables ico of bevy_image

jpeg

Enables jpeg of bevy_image

png

Enables png of bevy_image

pnm

Enables pnm of bevy_image

qoi

Enables qoi of bevy_image

tga

Enables tga of bevy_image

tiff

Enables tiff of bevy_image

webp

Enables webp of bevy_image

dds

Enables dds of bevy_image

exr

Enables exr of bevy_image

hdr

Enables hdr of bevy_image

ktx2 bluenoise_texture? smaa_luts? tonemapping_luts?

Enables ktx2 of bevy_image

spirv_shader_passthrough

Enable SPIR-V passthrough

Enables spirv_shader_passthrough of bevy_render

statically-linked-dxc

Statically linked DXC shader compiler for DirectX 12
TODO: When wgpu switches to DirectX 12 instead of Vulkan by default on windows, make this a default feature

Enables statically-linked-dxc of bevy_render

raw_vulkan_init

Forces the wgpu instance to be initialized using the raw Vulkan HAL, enabling additional configuration

Enables raw_vulkan_init of bevy_render

tonemapping_luts = ktx2

Include tonemapping LUT KTX2 files.

Enables zstd of bevy_image, tonemapping_luts of optional bevy_core_pipeline

smaa_luts = ktx2

Include SMAA LUT KTX2 Files

Enables zstd of bevy_image, smaa_luts of optional bevy_anti_alias

bluenoise_texture = ktx2

Include Bluenoise texture for environment map generation.

Enables zstd of bevy_image, bluenoise_texture of optional bevy_pbr

dlss

NVIDIA Deep Learning Super Sampling

Enables dlss of bevy_anti_alias and optional bevy_solari

force_disable_dlss

Forcibly disable DLSS so that cargo build --all-features works without the DLSS SDK being installed. Not meant for users.

Enables force_disable_dlss of optional bevy_anti_alias and optional bevy_solari

flac

Audio format support (vorbis is enabled by default)

Enables flac of bevy_audio

mp3

Enables mp3 of bevy_audio

vorbis

Enables vorbis of bevy_audio

wav

Enables wav of bevy_audio

symphonia-aac

Enables symphonia-aac of bevy_audio

symphonia-all

Enables symphonia-all of bevy_audio

symphonia-flac

Enables symphonia-flac of bevy_audio

symphonia-isomp4

Enables symphonia-isomp4 of bevy_audio

symphonia-vorbis

Enables symphonia-vorbis of bevy_audio

symphonia-wav

Enables symphonia-wav of bevy_audio

shader_format_glsl

Shader formats

Enables shader_format_glsl of optional bevy_pbr and bevy_shader

shader_format_spirv

Enables shader_format_spirv of optional bevy_render and bevy_shader

shader_format_wesl

Enables shader_format_wesl of bevy_shader

serialize bevy_remote?

Enables serialize of optional bevy_a11y, optional bevy_color, bevy_ecs, optional bevy_image, bevy_input, bevy_math, bevy_platform, optional bevy_render, optional bevy_scene, bevy_time, bevy_transform, optional bevy_ui, optional bevy_window, and optional bevy_winit

bevy_a11y:

bevy (optional)

multi_threaded = std

Enables multi_threaded of optional bevy_asset, bevy_ecs, optional bevy_render, and bevy_tasks

bevy_ecs:

Functionality

Enables multithreading support. Schedules will attempt to run systems on multiple threads whenever possible.

async-io = std

Enables async-io of bevy_tasks

bevy_tasks:

Use async-io's implementation of block_on instead of futures-lite's implementation.
This is preferred if your application uses async-io.

wayland

Display server protocol support (X11 is enabled by default)

Enables wayland of bevy_winit

x11

Enables x11 of bevy_winit

android-native-activity

Android activity support (choose one)

Enables android-native-activity of bevy_winit

android-game-activity

Enables android-game-activity of bevy_winit

pbr_transmission_textures

Transmission textures in StandardMaterial:

Enables pbr_transmission_textures of optional bevy_gltf and optional bevy_pbr

pbr_clustered_decals

Clustered Decal support

Enables pbr_clustered_decals of optional bevy_pbr

pbr_light_textures

Light Texture support

Enables pbr_clustered_decals and pbr_light_textures of optional bevy_pbr

pbr_multi_layer_material_textures

Multi-layer material textures in StandardMaterial:

Enables pbr_multi_layer_material_textures of optional bevy_gltf and optional bevy_pbr

pbr_anisotropy_texture

Anisotropy texture in StandardMaterial:

Enables pbr_anisotropy_texture of optional bevy_gltf and optional bevy_pbr

experimental_pbr_pcss

Percentage-closer soft shadows

Enables experimental_pbr_pcss of optional bevy_pbr

pbr_specular_textures

Specular textures in StandardMaterial:

Enables pbr_specular_textures of optional bevy_gltf and optional bevy_pbr

webgl

Optimise for WebGL2

Enables webgl of optional bevy_anti_alias, optional bevy_core_pipeline, optional bevy_gizmos, optional bevy_pbr, optional bevy_render, and optional bevy_sprite_render

webgpu

Enables webgpu of optional bevy_anti_alias, optional bevy_core_pipeline, optional bevy_gizmos, optional bevy_pbr, optional bevy_render, and optional bevy_sprite_render

bevy_ci_testing

Enable systems that allow for automated testing on CI

Enables bevy_ci_testing of bevy_dev_tools, ci_limits of optional bevy_render

animation = bevy_animation, bevy_color, bevy_mesh

Enable animation support, and glTF animation loading

Enables bevy_animation of optional bevy_gltf

bevy_shader bevy_render? shader_format_glsl? shader_format_spirv? shader_format_wesl?

Enables bevy_shader

bevy_image basis-universal? bevy_mesh? bevy_text? bevy_window? bluenoise_texture? bmp? compressed_image_saver? dds? exr? ff? gif? hdr? ico? jpeg? ktx2? png? pnm? qoi? smaa_luts? tga? tiff? tonemapping_luts? webp? zlib? zstd? zstd_c? zstd_rust? = bevy_asset, bevy_color

Enables bevy_image

bevy_sprite bevy_sprite_picking_backend? bevy_sprite_render? bevy_ui? = bevy_camera

Enables bevy_sprite

bevy_text bevy_ui? = bevy_image

Enables bevy_text, bevy_text of optional bevy_sprite and optional bevy_sprite_render

bevy_ui bevy_ui_picking_backend? bevy_ui_render? ghost_nodes? = bevy_sprite, bevy_text

Enables bevy_ui

bevy_mesh animation? bevy_camera? = bevy_image

Enables bevy_mesh

bevy_window bevy_camera? bevy_winit? custom_cursor? = bevy_image

Enables bevy_a11y and bevy_window

bevy_winit accesskit_unix? android-game-activity? android-native-activity? custom_cursor? wayland? x11? = bevy_window

Enables bevy_winit

bevy_camera bevy_gizmos? bevy_light? bevy_render? bevy_sprite? = bevy_mesh, bevy_window

Enables bevy_camera

bevy_scene bevy_gltf? = bevy_asset

Enables bevy_scene

bevy_light bevy_pbr? = bevy_camera

Enables bevy_light

bevy_render bevy_core_pipeline? raw_vulkan_init? spirv_shader_passthrough? statically-linked-dxc? = bevy_camera, bevy_shader

Enables bevy_render, encase and wgpu-types of bevy_color, bevy_render of optional bevy_gizmos

bevy_core_pipeline bevy_anti_alias? bevy_pbr? bevy_post_process? bevy_sprite_render? = bevy_render

Enables bevy_core_pipeline

bevy_anti_alias dlss? = bevy_core_pipeline

Enables bevy_anti_alias

bevy_post_process = bevy_core_pipeline

Enables bevy_post_process

bevy_pbr bevy_gltf? bevy_solari? = bevy_core_pipeline, bevy_light

Enables bevy_pbr, bevy_pbr of optional bevy_gizmos

bevy_sprite_render bevy_ui_render? = bevy_core_pipeline, bevy_sprite

Enables bevy_sprite_render, bevy_sprite_render of optional bevy_gizmos

bevy_ui_render = bevy_sprite_render, bevy_ui

Enables bevy_ui_render

bevy_solari = bevy_pbr

Enables bevy_solari

bevy_gizmos = bevy_camera

Enables bevy_gizmos

bevy_gltf = bevy_pbr, bevy_scene

Enables bevy_gltf

dynamic_linking

Used to disable code that is unsupported when Bevy is dynamically linked

Enables dynamic_linking of bevy_diagnostic

android_shared_stdcxx

Enable using a shared stdlib for cxx on Android.

Enables android_shared_stdcxx of bevy_audio

accesskit_unix

Enable AccessKit on Unix backends (currently only works with experimental screen readers and forks.)

Enables accesskit_unix of bevy_winit

glam_assert

Enable assertions to check the validity of parameters passed to glam

Enables glam_assert of bevy_math

debug_glam_assert

Enable assertions in debug builds to check the validity of parameters passed to glam

Enables debug_glam_assert of bevy_math

default_font

Enables default_font of optional bevy_text

http

Enables downloading assets from HTTP sources

Enables http of optional bevy_asset

https

Enables downloading assets from HTTPS sources

Enables https of optional bevy_asset

web_asset_cache

Enable caching downloaded assets on the filesystem. NOTE: this cache currently never invalidates entries!

Enables web_asset_cache of optional bevy_asset

asset_processor

Enables the built-in asset processor for processed assets.

Enables asset_processor of optional bevy_asset

file_watcher

Enables watching the filesystem for Bevy Asset hot-reloading

Enables file_watcher of optional bevy_asset

embedded_watcher

Enables watching embedded files for Bevy Asset hot-reloading

Enables embedded_watcher of optional bevy_asset

bevy_debug_stepping

Enable system stepping support

Enables bevy_debug_stepping of bevy_app and bevy_ecs

meshlet

Enables the meshlet renderer for dense high-poly scenes (experimental)

Enables meshlet of optional bevy_pbr

meshlet_processor

Enables processing meshes into meshlet meshes for bevy_pbr

Enables meshlet_processor of optional bevy_pbr

bevy_dev_tools bevy_ci_testing?

Provides a collection of developer tools

Enables bevy_dev_tools

bevy_remote = serialize

Enable support for the Bevy Remote Protocol

Enables bevy_remote

bevy_picking bevy_mesh_picking_backend? bevy_sprite_picking_backend? bevy_ui_picking_backend?

Provides picking functionality

Enables bevy_picking

bevy_mesh_picking_backend = bevy_picking

Provides a mesh picking backend

Enables bevy_mesh_picking_backend of bevy_picking

bevy_sprite_picking_backend = bevy_picking

Provides a sprite picking backend

Enables bevy_sprite_picking_backend of bevy_sprite

bevy_ui_picking_backend = bevy_picking

Provides a UI picking backend

Enables bevy_ui_picking_backend of bevy_ui

bevy_ui_debug

Provides a UI debug overlay

Enables bevy_ui_debug of optional bevy_ui_render

bevy_state

Enable built in global state machines

Enables bevy_state

track_location

Enables source location tracking for change detection, which can assist with debugging

Enables track_location of bevy_ecs

reflect_functions

Enable function reflection

Enables functions of bevy_reflect, reflect_functions of bevy_app and bevy_ecs

reflect_auto_register

Enable automatic reflect registration using inventory.

Enables auto_register_inventory of bevy_reflect, reflect_auto_register of bevy_app and bevy_ecs

reflect_auto_register_static

Enable automatic reflect registration without inventory. See reflect::load_type_registrations for more info.

Enables auto_register_static of bevy_reflect, reflect_auto_register of bevy_app and bevy_ecs

reflect_documentation

Enable documentation reflection

Enables documentation of bevy_reflect

custom_cursor

Enable custom cursor support

Enables custom_cursor of bevy_window and bevy_winit

ghost_nodes

Experimental support for nodes that are ignored for UI layouting

Enables ghost_nodes of bevy_ui

std async-io? async_executor? multi_threaded?

Allows access to the std crate. Enabling this feature will prevent compilation on no_std targets, but provides access to certain additional features on supported platforms.

Enables std of optional bevy_a11y, bevy_app, optional bevy_color, bevy_diagnostic, bevy_ecs, bevy_input, optional bevy_input_focus, bevy_math, bevy_platform, bevy_reflect, optional bevy_state, bevy_time, bevy_transform, and optional bevy_window

critical-section

critical-section provides the building blocks for synchronization primitives on all platforms, including no_std.

Enables critical-section of optional bevy_a11y, bevy_app, bevy_diagnostic, bevy_ecs, bevy_input, optional bevy_input_focus, bevy_platform, bevy_reflect, optional bevy_state, and bevy_time

libm

Uses the libm maths library instead of the one provided in std and core.

Enables libm of optional bevy_color, bevy_input, optional bevy_input_focus, bevy_math, bevy_transform, and optional bevy_window

async_executor = std

Uses async-executor as a task execution backend. This backend is incompatible with no_std targets.

Enables async_executor of bevy_ecs, bevy_tasks, and bevy_transform

web

Enables use of browser APIs. Note this is currently only applicable on wasm32 architectures.

Enables web of bevy_app, bevy_platform, and bevy_reflect

hotpatching

Enables hotpatching of bevy_app and bevy_ecs

debug

Enables debug of bevy_utils

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

bevy_log trace? trace_chrome? trace_tracy? trace_tracy_memory?

bevy_animation animation?

bevy_asset bevy_image? bevy_scene?

bevy_audio android_shared_stdcxx? flac? mp3? symphonia-aac? symphonia-all? symphonia-flac? symphonia-isomp4? symphonia-vorbis? symphonia-wav? vorbis? wav?

bevy_color animation? bevy_image? bevy_render?

bevy_ui_widgets implicit feature

Enables bevy_ui_widgets

bevy_ui_widgets:

Unstyled common widgets for Bevy Engine

bevy_gilrs implicit feature

Enables bevy_gilrs

bevy_gilrs:

Gamepad system made using Gilrs for Bevy Engine

bevy_feathers implicit feature

Enables bevy_feathers

bevy_feathers:

A collection of UI widgets for building editors and utilities in Bevy

bevy_input_focus implicit feature

Enables bevy_input_focus

bevy_input_focus:

Keyboard focus management