Expand description
This crate provide methods to create/destroy and otherwise manage device resources. Primarily focus on buffers and images.
Structs§
- Access
- Buffer access flags.
- Buffer
- Generic buffer resource wrapper.
- Buffer
Info - Buffer info.
- Descriptor
Set - Generic descriptor set resource wrapper.
- Descriptor
SetInfo - Descriptor set layout info.
- Descriptor
SetLayout - Generic descriptor set layout resource wrapper.
- Escape
- Allows values to “escape” dropping by sending them to the
Terminal
. - Extent
- Describes the size of an image, which may be up to three dimensional.
- Format
Properties - Image format properties.
- Handle
- Allows values to “escape” dropping by sending them to the
Terminal
. Permit sharing unlikeEscape
- Image
- Generic image resource wrapper.
- Image
Info - Image info.
- Image
View - Generic image view resource wrapper.
- Image
View Info - Image view info
- Index
Buffer View - Index buffer view for
bind_index_buffer
. - Lod
- A wrapper for the LOD level of an image. Needed so that we can implement Eq and Hash for it.
- Offset
- An offset into an
Image
used for image-to-image copy operations. All offsets are in texels, and specifying offsets other than 0 for dimensions that do not exist is undefined behavior – for example, specifying az
offset of1
in a two-dimensional image. - Packed
Color - A wrapper for an RGBA color with 8 bits per texel, encoded as a u32.
- Resource
Tracker - Resource handler.
- Sampler
- Generic sampler resource wrapper.
- Sampler
Cache - Sampler cache holds handlers to created samplers.
- Sampler
Desc - Specifies how to sample from an image. These are all the parameters available that alter how the GPU goes from a coordinate in an image to producing an actual value from the texture, including filtering/ scaling, wrap mode, etc.
- Subresource
- Selector of a concrete subresource in an image.
- Subresource
Footprint - Footprint of a subresource in memory.
- Subresource
Layers - A subset of resource layers contained within an image’s level.
- Subresource
Range - A subset of resources contained within an image.
- Terminal
- This types allows the user to create
Escape
wrappers. Receives values from droppedEscape
instances that was created by thisTerminal
. - Usage
- Buffer usage flags.
- View
Capabilities - Capabilities to create views into an image.
Enums§
- Anisotropic
- Anisotropic filtering description for the sampler.
- Creation
Error - Error creating a resource.
- Cube
Face - The face of a cube image to do an operation on.
- Filter
- How to filter the image when sampling. They correspond to increasing levels of quality, but also cost.
- Kind
- Specifies the dimensionality of an image to be allocated, along with the number of mipmap layers and MSAA samples if applicable.
- Layer
Error - An error associated with selected image layer.
- Layout
- Specifies options for how memory for an image is arranged. These are hints to the GPU driver and may or may not have actual performance effects, but describe constraints on how the data may be used that a program must obey. They do not specify how channel values or such are laid out in memory; the actual image data is considered opaque.
- Tiling
- Image tiling modes.
- View
Creation Error - Error creating a buffer view.
- View
Error - Error creating an
ImageView
. - View
Kind - Specifies the kind/dimensionality of an image view.
- Wrap
Mode - Specifies how image coordinates outside the range
[0, 1]
are handled.
Constants§
- CUBE_
FACES - A constant array of cube faces in the order they map to the hardware.
- MAX_
LEVEL - Maximum accessible mipmap level of an image.
Type Aliases§
- Buffer
Creation Error - Alias for the error to create a buffer.
- Image
Creation Error - Alias for the error to create an image.
- Image
View Creation Error - Alias for the error to create an image view.
- Layer
- Image layer.
- Level
- Image mipmap level.
- NumSamples
- Number of MSAA samples.
- Offset
- An offset inside a buffer, in bytes.
- Size
- Dimension size.
- State
- Buffer state.
- Texel
Coordinate - A texel coordinate in an image.