Crate chaos_vk

Crate chaos_vk 

Source

Modules§

__core
The Rust Core Library
acceleration_structure
An opaque data structure that is used to accelerate spatial queries on geometry data.
buffer
Location in memory that contains data.
color
command_buffer
Recording commands to execute on the device.
deferred
Operations on the host that can be deferred.
descriptor_set
Bindings between shaders and the resources they access.
device
Communication channel with a physical device.
display
Control and use of display devices (e.g. monitors).
dpi
UI scaling is important, so read the docs for this module if you don’t want to be confused.
drag_drop
Structs to create a Drag and Drop sequence. Almost all structs are re-exported and can be accessed from the crate root; some additional utilities can be found in here.
draw_list
The draw list lets you create custom graphics within a window.
error
event
The Event enum and assorted supporting types.
event_loop
The EventLoop struct and assorted supporting types, including ControlFlow.
format
All the formats supported by Vulkan.
graphics
half
A crate that provides support for half-precision 16-bit floating point types.
image
Image storage (1D, 2D, 3D, arrays, etc.) and image views.
imgui_renderer
instance
API entry point.
internal
Internal raw utilities (don’t use unless you know what you’re doing!)
library
Vulkan library loading system.
memory
Device memory allocation and memory pools.
monitor
Types useful for interacting with a user’s monitors.
padded
A newtype wrapper for enforcing correct alignment for external types.
pipeline
Describes a processing operation that will execute on the Vulkan device.
platform
Contains traits with platform-specific methods in them.
query
Gather information about rendering, held in query pools.
range_set
render_pass
Description of the steps of the rendering process, and the images used as input or output.
shader
A program that is run on the device.
swapchain
Link between Vulkan and a window and/or the screen.
sync
Synchronization on the GPU.
sys
text_filter
window
The Window struct and associated types.

Macros§

create_token
This is a macro used internally by imgui-rs to create StackTokens representing various global state in DearImGui.
impl_vertexDeprecated
Implements the Vertex trait on a struct.
impl_vertex_member
ordered_passes_renderpass
Builds a RenderPass object whose template parameter is of indeterminate type.
shader
single_pass_renderpass
Builds a RenderPass object whose template parameter is of indeterminate type.
statically_linked_vulkan_loader
Expression that returns a loader that assumes that Vulkan is linked to the executable you’re compiling.
type_for_format
Converts a format enum identifier to a standard Rust type that is suitable for representing the format in a buffer or image.

Structs§

AngleSlider
Builder for an angle slider widget.
BackendFlags
Backend capabilities
ButtonFlags
Flags for invisible buttons
ChannelsSplit
Represent the drawing interface within a call to channels_split.
ChildWindow
Builder for a child window
ChildWindowToken
Tracks a child window that can be ended by calling .end() or by dropping
CollapsingHeader
Builder for a collapsing header widget
ColorButton
Builder for a color button widget.
ColorEdit3
Builder for a color editor widget.
ColorEdit4
Builder for a color editor widget.
ColorEditFlags
Color edit flags
ColorPicker3
Builder for a color picker widget.
ColorPicker4
Examples
ColorStackToken
Tracks a color pushed to the color stack that can be popped by calling .end() or by dropping.
ComboBox
Builder for a combo box widget
ComboBoxFlags
Flags for combo boxes
ComboBoxToken
Tracks a combo box that can be ended by calling .end() or by dropping.
ConfigFlags
Configuration flags
Context
An imgui-rs context.
DisabledToken
Starts a scope where interaction is disabled. Ends be calling .end() or when the token is dropped.
Drag
Builder for a drag slider widget.
DragDropFlags
Flags for igBeginDragDropSource(), igAcceptDragDropPayload()
DragDropSource
Creates a source for drag drop data out of the last ID created.
DragDropTarget
Creates a target for drag drop data out of the last ID created.
DragRange
Builder for a drag slider widget.
DrawCmdIterator
DrawCmdParams
DrawData
All draw data to render a Dear ImGui frame.
DrawList
Draw command list
DrawListIterator
Iterator over draw lists
DrawListMut
Object implementing the custom draw API.
DrawVert
A single vertex
DummyClipboardContext
Non-functioning placeholder
ExtensionProperties
Properties of an extension in the loader or a physical device.
Font
Runtime data for a single font within a font atlas
FontAtlas
A font atlas that builds a single texture
FontAtlasFlags
Font atlas configuration flags
FontAtlasTexture
Handle to a font atlas texture
FontConfig
Configuration settings for a font
FontGlyph
A single font glyph
FontGlyphRanges
A set of Unicode codepoints
FontId
A font identifier
FontStackToken
Tracks a font pushed to the font stack that can be popped by calling .end() or by dropping.
GroupToken
Tracks a layout group that can be ended with end or by dropping.
Id
Unique ID used by widgets.
IdStackToken
Tracks an ID pushed to the ID stack that can be popped by calling .pop() or by dropping. See crate::Ui::push_id for more details.
ImColor32
Wraps u32 that represents a packed RGBA color. Mostly used by types in the low level custom drawing API, such as DrawListMut.
ImStr
A UTF-8 encoded, implicitly nul-terminated string slice.
ImString
A UTF-8 encoded, growable, implicitly nul-terminated string.
Image
Builder for an image widget
ImageButton
Builder for an image button widget
ImageButtonDeprecated
InputFloat
InputFloat2
InputFloat3
InputFloat4
InputInt
InputInt2
InputInt3
InputInt4
InputScalar
Builder for an input scalar widget.
InputScalarN
Builder for an input scalar widget.
InputText
InputTextCallback
Callback flags for an InputText widget. These correspond to the general textflags.
InputTextFlags
Flags for text inputs
InputTextMultiline
InputTextMultilineCallback
Callback flags for an InputTextMultiline widget. These correspond to the general textflags.
InvalidStyleColorValue
Io
Settings and inputs/outputs for imgui-rs
ItemFlagsStackToken
Tracks a change pushed to the item flags stack.
ItemHoveredFlags
Item hover check option flags
ItemWidthStackToken
ListBox
Builder for a list box widget
ListBoxToken
Tracks a list box that can be ended by calling .end() or by dropping
ListClipper
Used to render only the visible items when displaying a long list of items in a scrollable area.
MainMenuBarToken
Tracks a main menu bar that can be ended by calling .end() or by dropping
MenuBarToken
Tracks a menu bar that can be ended by calling .end() or by dropping
MenuItem
Builder for a menu item.
MenuToken
Tracks a menu that can be ended by calling .end() or by dropping
NonExhaustive
A helper type for non-exhaustive structs.
OwnedDrawData
A container for a heap-allocated deep copy of a DrawData struct.
Packed24_8
Holds 24 bits in the least significant bits of memory, and 8 bytes in the most significant bits of that memory, occupying a single u32 in total.
PassthroughCallback
This is a Zst which implements TextCallbackHandler as a passthrough.
PlotHistogram
PlotLines
PopupModal
Create a modal pop-up.
PopupToken
Tracks a popup token that can be ended with end or by dropping.
ProgressBar
Builder for a progress bar widget.
PushAllowKeyboardFocusToken
PushButtonRepeatToken
RequiresAllOf
Used in errors to indicate a set of requirements that all need to be available/enabled to allow a given operation.
RequiresOneOf
Used in errors to indicate a set of alternatives that needs to be available/enabled to allow a given operation.
Selectable
Builder for a selectable widget.
SelectableFlags
Flags for selectables
SharedFontAtlas
A font atlas that can be shared between contexts
Slider
Builder for a slider widget.
SliderFlags
Flags for sliders
Style
User interface style/colors
StyleStackToken
Tracks a style pushed to the style stack that can be popped by calling .end() or by dropping.
SuspendedContext
A suspended imgui-rs context.
TabBar
Builder for a tab bar.
TabBarFlags
TabBarToken
Tracks a window that can be ended by calling .end() or by dropping
TabItem
TabItemFlags
TabItemToken
Tracks a tab bar item that can be ended by calling .end() or by dropping
TextCallbackData
This struct provides methods to edit the underlying text buffer that Dear ImGui manipulates. Primarily, it gives remove_chars, insert_chars, and mutable access to what text is selected.
TextFilter
Helper to parse and apply text filters
TextWrapPosStackToken
TextureId
An opaque texture identifier
Textures
Generic texture mapping for use by renderers.
TooltipToken
Tracks a layout tooltip that can be ended by calling .end() or by dropping.
TreeNode
Builder for a tree node widget
TreeNodeFlags
Flags for tree nodes
TreeNodeToken
Tracks a tree node that can be popped by calling .pop(), end(), or by dropping.
Ui
A reference for building the user interface for one frame
UiBuffer
this is the unsafe cell upon which we build our abstraction.
ValidationError
The arguments or other context of a call to a Vulkan function were not valid.
Version
Represents an API version of Vulkan.
VerticalSlider
Builder for a vertical slider widget.
VulkanLibrary
A loaded library containing a valid Vulkan implementation.
Window
Builder for a window
WindowFlags
Configuration flags for windows
WindowFocusedFlags
Window focus check option flags
WindowHoveredFlags
Window hover check option flags
WindowToken
Tracks a window that can be ended by calling .end() or by dropping.

Enums§

ColorEditDisplayMode
Color editor display mode.
ColorEditInputMode
Color editor input mode.
ColorFormat
Color component formatting
ColorPickerMode
Color picker hue/saturation/value editor mode
ColorPreview
Color editor preview style
ComboBoxHeight
Combo box height mode.
ComboBoxPreviewMode
Combo box preview mode.
Condition
Condition for applying a setting
Direction
A cardinal direction
DrawCmd
A draw command
FocusedWidget
Target widget selection for keyboard focus
FontSource
A source for binary font data
HistoryDirection
The arrow key a user pressed to trigger the on_history callback.
ItemFlag
A temporary change in item flags
Key
A key identifier
LoadingError
Error that can happen when loading a Vulkan library.
MouseButton
Represents one of the supported mouse buttons
MouseCursor
Mouse cursor type identifier
NavInput
An input identifier for navigation
Requires
Something that needs to be supported or enabled to allow a particular operation.
StyleColor
A color identifier for styling.
StyleVar
A temporary change in user interface style
TreeNodeId
Unique ID used by tree nodes
Validated
A wrapper for error types of functions that can return validation errors.
VulkanError
An enumeration of runtime errors that can be returned by Vulkan.

Traits§

ClipboardBackend
Trait for clipboard backends
Handle
InputTextCallbackHandler
This trait provides an interface which ImGui will call on InputText and InputTextMultiline callbacks.
SafeDeref
Alternative to the Deref trait. Contrary to Deref, must always return the same object.
VulkanObject
Gives access to the internal identifier of an object.

Functions§

dear_imgui_version
Returns the underlying Dear ImGui library version

Type Aliases§

DeviceAddress
https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkDeviceAddress.html
DeviceSize
https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkDeviceSize.html
DrawIdx
A vertex index
NonNullDeviceAddress
A DeviceAddress that is known not to equal zero.
NonZeroDeviceSize
A DeviceSize that is known not to equal zero.