Struct sierra::Device

#[repr(transparent)]
pub struct Device { /* fields omitted */ }

Opaque value that represents graphics API device. It is used to manage (create, destroy, check state) most of the device resources.

Implementations

impl Device

pub fn graphics(&self) -> &'static Graphics

Returns graphics associated with the device instance.

pub fn downgrade(&self) -> WeakDevice

Returns weak reference to this device.

pub fn create_buffer(&self, info: BufferInfo) -> Result<Buffer, OutOfMemory>

Creates buffer with uninitialized content.

pub fn create_mappable_buffer(
    &self,
    info: BufferInfo,
    memory_usage: MemoryUsage
) -> Result<MappableBuffer, OutOfMemory>

Creates buffer with uninitialized content.

pub fn create_buffer_static<T: 'static>(
    &self,
    info: BufferInfo,
    data: &[T]
) -> Result<Buffer, OutOfMemory> where
    T: Pod, 

Creates static buffer with preinitialized content from data. Implies MemoryUsage::Device.

Panics

Function will panic if creating buffer size does not equal data size. E.g. if info.size != std::mem::size_of(data).

pub fn create_fence(&self) -> Result<Fence, OutOfMemory>

Creates a fence. Fences are create in unsignaled state.

pub fn create_framebuffer(
    &self,
    info: FramebufferInfo
) -> Result<Framebuffer, OutOfMemory>

Creates framebuffer for specified render pass from views.

pub fn create_graphics_pipeline(
    &self,
    info: GraphicsPipelineInfo
) -> Result<GraphicsPipeline, OutOfMemory>

Creates graphics pipeline.

pub fn create_compute_pipeline(
    &self,
    info: ComputePipelineInfo
) -> Result<ComputePipeline, OutOfMemory>

Creates compute pipeline.

pub fn create_image(&self, info: ImageInfo) -> Result<Image, CreateImageError>

Creates image with uninitialized content.

pub fn create_image_view(
    &self,
    info: ImageViewInfo
) -> Result<ImageView, OutOfMemory>

Creates view to an image.

pub fn create_pipeline_layout(
    &self,
    info: PipelineLayoutInfo
) -> Result<PipelineLayout, OutOfMemory>

Creates pipeline layout.

pub fn create_render_pass(
    &self,
    info: RenderPassInfo
) -> Result<RenderPass, CreateRenderPassError>

Creates render pass.

pub fn create_semaphore(&self) -> Result<Semaphore, OutOfMemory>

Creates semaphore. Semaphores are created in unsignaled state.

pub fn create_shader_module(
    &self,
    info: ShaderModuleInfo
) -> Result<ShaderModule, CreateShaderModuleError>

Creates new shader module from shader’s code.

pub fn create_swapchain(
    &self,
    surface: &mut Surface
) -> Result<Swapchain, SurfaceError>

Creates swapchain for specified surface. Only one swapchain may be associated with one surface.

pub fn reset_fences(&self, fences: &mut [&mut Fence])

Resets fences. All specified fences must be in signalled state. Fences are moved into unsignalled state.

pub fn is_fence_signalled(&self, fence: &mut Fence) -> bool

Checks if fence is in signalled state.

pub fn wait_fences(&self, fences: &mut [&mut Fence], all: bool)

Wait for fences to become signaled. If all is true - waits for all specified fences to become signaled. Otherwise waits for at least on of specified fences to become signaled. May return immediately if all fences are already signaled (or at least one is signaled if all == false). Fences are signaled by Queues. See Queue::submit.

pub fn wait_idle(&self)

Wait for whole device to become idle. That is, wait for all pending operations to complete. This is equivalent to calling Queue::wait_idle for all queues. Typically used only before device destruction.

pub fn get_acceleration_structure_build_sizes(
    &self,
    level: AccelerationStructureLevel,
    flags: AccelerationStructureBuildFlags,
    geometry: &[AccelerationStructureGeometryInfo]
) -> AccelerationStructureBuildSizesInfo

Returns memory size requirements for accelelration structure build operations.

pub fn create_acceleration_structure(
    &self,
    info: AccelerationStructureInfo
) -> Result<AccelerationStructure, OutOfMemory>

Creates acceleration structure.

Panics

This method may panic if Feature::RayTracing wasn’t enabled.

pub fn get_buffer_device_address(
    &self,
    buffer: &Buffer
) -> Option<DeviceAddress>

Returns buffers device address.

pub fn get_acceleration_structure_device_address(
    &self,
    acceleration_structure: &AccelerationStructure
) -> DeviceAddress

Returns device address of acceleration strucutre.

pub fn create_ray_tracing_pipeline(
    &self,
    info: RayTracingPipelineInfo
) -> Result<RayTracingPipeline, OutOfMemory>

Creates ray-tracing pipeline.

pub fn create_descriptor_set_layout(
    &self,
    info: DescriptorSetLayoutInfo
) -> Result<DescriptorSetLayout, OutOfMemory>

pub fn create_descriptor_set(
    &self,
    info: DescriptorSetInfo
) -> Result<DescriptorSet, DescriptorsAllocationError>

pub fn update_descriptor_sets<'a>(
    &self,
    writes: &[WriteDescriptorSet<'a>],
    copies: &[CopyDescriptorSet<'a>]
)

pub fn create_sampler(&self, info: SamplerInfo) -> Result<Sampler, OutOfMemory>

pub fn create_shader_binding_table(
    &self,
    pipeline: &RayTracingPipeline,
    info: ShaderBindingTableInfo<'_>
) -> Result<ShaderBindingTable, OutOfMemory>

pub fn map_memory(
    &self,
    buffer: &mut MappableBuffer,
    offset: u64,
    size: usize
) -> Result<&mut [MaybeUninit<u8>], MapError>

pub fn unmap_memory(&self, buffer: &mut MappableBuffer) -> bool

pub fn write_buffer<T>(
    &self,
    buffer: &mut MappableBuffer,
    offset: u64,
    data: &[T]
) -> Result<(), MapError> where
    T: Pod, 

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl PartialEq<WeakDevice> for Device

fn eq(&self, weak: &WeakDevice) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<WeakDevice> for &Device

fn eq(&self, weak: &WeakDevice) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.