WebGPU Library for Lily

fn RenderPass::add_color_attachment(
  self,
  attachment: ColorAttachment
)

Adds a [ColorAttachment] to render into.

If no color attachments are set, the pass renders to the screen.

fn RenderPass::set_depth_attachment(
  self,
  depth_view: TextureViewHandle
)

Sets the depth attachment for depth testing using a [TextureViewHandle].

fn RenderPass::set_depth_ops(
  self,
  should_clear: Bool,
  clear_value: F32,
  store: Bool
)

Configures depth load/store.

fn RenderPass::set_pipeline(
  self,
  pipeline: RenderPipelineHandle
)

Sets the active [RenderPipelineHandle] for upcoming draw calls.

fn RenderPass::set_viewport(
  self,
  viewport: Viewport
)

Sets the [Viewport] for future draw calls.

fn RenderPass::set_scissor_rect(
  self,
  rect: ScissorRect
)

Clips rendering to a [ScissorRect].

fn RenderPass::set_stencil_reference(
  self,
  reference_value: Int
)

Sets the stencil reference value for stencil testing.

fn RenderPass::set_bind_group(
  self,
  group_index: Int,
  bind_group: BindGroupHandle
)

Binds a [BindGroupHandle] at group_index for future draw calls.

group_index is the bind group slot, the @group(N) in WGSL and the position of that group’s layout in the array passed to [create_pipeline_layout].

fn RenderPass::set_vertex_buffer(
  self,
  slot: Int,
  vertex_buffer: BufferHandle
)

Sets the [BufferHandle] at vertex buffer slot.

slot is the index of the [VertexBufferLayout] in [create_render_pipeline].

fn RenderPass::set_index_buffer(
  self,
  index_buffer: BufferHandle
)

Sets the index [BufferHandle] for indexed drawing.

Only buffers created with [create_index_buffer_u16] are supported.

fn RenderPass::draw(
  self,
  vertex_range: Range,
  instance_range: Range
)

Draws vertices without an index buffer. Prefer [draw_indexed] if possible.

vertex_range selects vertices by [Range] (start and count). instance_range selects instances the same way. Use count: 1 for a single draw.

fn RenderPass::draw_indexed(
  self,
  index_range: Range,
  instance_range: Range
)

Draws indexed geometry using the index buffer set by [RenderPass::set_index_buffer].

index_range selects indices by [Range] (start and ocunt). instance_range selects instances the same way. Use count: 1 for a single draw.

fn create_index_buffer_u16(
  buffer: Any,
  description: String
) -> BufferHandle

fn create_vertex_buffer(
  buffer: Any,
  description: String
) -> BufferHandle

fn create_buffer(
  size: Int,
  usage: BufferUsage,
  description: String
) -> BufferHandle

Creates an empty GPU buffer without initial data.

fn create_bind_group(
  bind_group_layout: BindGroupLayoutHandle,
  entries: [BindGroupEntry],
  description: String
) -> BindGroupHandle

Creates a bind group instance for a layout from [create_bind_group_layout].

entries are assigned to @binding(0), @binding(1), … in array order. The layout must declare bindings in that same sequential order.

fn create_sampler(
  config: SamplerConfig,
  description: String
) -> SamplerHandle

fn create_sampled_texture(
  width: Int,
  height: Int,
  format: SampledTextureFormat,
  description: String
) -> TextureHandle

Creates an empty texture that can be sampled (read).

fn create_render_texture(
  width: Int,
  height: Int,
  format: RenderTextureFormat,
  description: String
) -> TextureHandle

Creates an empty texture that can be used as a color render attachment.

fn create_render_sampled_texture(
  width: Int,
  height: Int,
  format: SampledTextureFormat,
  description: String
) -> TextureHandle

Creates an empty texture that can be both rendered to (write) and sampled (read).

fn create_storage_texture(
  width: Int,
  height: Int,
  format: StorageTextureFormat,
  description: String
) -> TextureHandle

Creates an empty texture that can be used as a storage texture.

fn create_depth_texture(
  width: Int,
  height: Int,
  format: DepthTextureFormat,
  description: String
) -> TextureHandle

Creates an empty texture that can be used as a depth/stencil attachment.

fn create_sampled_texture_png(
  image: Image,
  format: SampledTextureFormat,
  description: String
) -> TextureHandle

fn create_render_sampled_texture_png(
  image: Image,
  format: SampledTextureFormat,
  description: String
) -> TextureHandle

fn create_texture_view(
  texture: TextureHandle,
  description: String
) -> TextureViewHandle

Creates a view into a texture for rendering or sampling

fn create_bind_group_layout(
  entries: [BindGroupLayoutEntry],
  description: String
) -> BindGroupLayoutHandle

Describes the resources at each [BindGroupLayoutEntry::binding] within one bind group.

fn create_pipeline_layout(
  groups: [BindGroupLayoutHandle],
  description: String
) -> PipelineLayoutHandle

Creates a pipeline layout from bind group layouts in group-index order.

The first layout is group index 0 (@group(0)), the second is 1, and so on.

fn create_render_pipeline(
  layout: PipelineLayoutHandle,
  buffers: [VertexBufferLayout],
  shader_module: Shader,
  options: RenderPipelineOptions,
  description: String
) -> RenderPipelineHandle

Creates a render pipeline targeting the current surface (swapchain) format.

fn create_render_pipeline_with_color_format(
  layout: PipelineLayoutHandle,
  buffers: [VertexBufferLayout],
  shader_module: Shader,
  color_format: RenderTextureFormat,
  options: RenderPipelineOptions,
  description: String
) -> RenderPipelineHandle

Creates a render pipeline targeting an explicit color format (for offscreen pipelines).

fn add_pass(pass: RenderPass, description: String)

Submits a render pass for execution

fn create_uniform_buffer(
  buffer: Any,
  description: String
) -> BufferHandle

fn surface_extent() -> (Int, Int)

The size of the renderable surface. Return (Width, Height).