androidx.webgpu
Interfaces
DeviceLostCallback | |
GPURequestCallback | A generic callback interface for asynchronous GPU requests. |
UncapturedErrorCallback |
Classes
GPUAdapter | Represents a physical graphics adapter. |
GPUAdapterInfo | Provides detailed information about a graphics adapter. |
GPUBindGroup | A collection of resources to be bound to a pipeline. |
GPUBindGroupDescriptor | Describes a bind group, which is a collection of resources to be bound to a pipeline. |
GPUBindGroupEntry | Describes a single resource binding within a bind group. |
GPUBindGroupEntry.Builder | Builder for |
GPUBindGroupLayout | The layout of a bind group, defining the types of its resources. |
GPUBindGroupLayoutDescriptor | Describes the layout of a bind group, specifying the types of resources it contains. |
GPUBindGroupLayoutEntry | Describes a single binding within a bind group layout. |
GPUBindGroupLayoutEntry.Builder | Builder for |
GPUBlendComponent | Defines the blending behavior for a single color component (color or alpha). |
GPUBlendState | Defines the blending configuration for a color attachment. |
GPUBuffer | A block of memory accessible by the GPU. |
GPUBufferBindingLayout | Describes the layout of a buffer binding. |
GPUBufferDescriptor | Describes a buffer to be created. |
GPUColor | Represents an RGBA color value. |
GPUColorTargetState | Describes the state of a single color target in a render pipeline. |
GPUCommandBuffer | A recorded sequence of GPU commands. |
GPUCommandBufferDescriptor | Describes a command buffer. |
GPUCommandEncoder | An object used to record GPU commands. |
GPUCommandEncoderDescriptor | Describes a command encoder. |
GPUCompilationInfo | Contains information about a shader compilation, including messages. |
GPUCompilationMessage | Describes a single message generated during shader compilation. |
GPUComputePassDescriptor | Describes a compute pass. |
GPUComputePassEncoder | An object used to record commands for a compute pass. |
GPUComputePipeline | A pipeline for compute operations. |
GPUComputePipelineDescriptor | Describes a compute pipeline. |
GPUComputeState | Describes the compute shader stage of a pipeline. |
GPUConstantEntry | Defines a key-value pair for a pipeline-overridable constant. |
GPUDepthStencilState | Describes the depth and stencil state for a render pipeline. |
GPUDepthStencilState.Builder | Builder for |
GPUDevice | A logical graphics device. |
GPUDeviceDescriptor | Describes a device to be created. |
GPUDeviceDescriptor.Builder | Builder for |
GPUExtent3D | Defines a three-dimensional extent (width, height, depth/layers). |
GPUFragmentState | Describes the fragment shader stage of a render pipeline. |
GPUInstance | A top-level object representing a WebGPU instance. |
GPUInstanceDescriptor | Describes an instance to be created. |
GPUInstanceLimits | Defines limits for an instance. |
GPULimits | Defines the resource limits for a device. |
GPULimits.Builder | Builder for |
GPUMultisampleState | Describes the multisampling state for a render pipeline. |
GPUOrigin3D | Defines a three-dimensional origin point (x, y, z). |
GPUPassTimestampWrites | Describes the timestamp queries to be written during a pass. |
GPUPipelineLayout | The layout of a pipeline, defining the bind groups it uses. |
GPUPipelineLayoutDescriptor | Describes a pipeline layout. |
GPUPrimitiveState | Describes the primitive assembly and rasterization state for a render pipeline. |
GPUPrimitiveState.Builder | Builder for |
GPUQuerySet | A set of queries for occlusion or timestamp measurements. |
GPUQuerySetDescriptor | Describes a query set. |
GPUQueue | A queue for submitting command buffers to the GPU. |
GPUQueueDescriptor | Describes a queue. |
GPURenderBundle | A pre-recorded sequence of rendering commands. |
GPURenderBundleDescriptor | Describes a render bundle. |
GPURenderBundleEncoder | An object used to record commands for a render bundle. |
GPURenderBundleEncoderDescriptor | Describes a render bundle encoder. |
GPURenderBundleEncoderDescriptor.Builder | Builder for |
GPURenderPassColorAttachment | Describes a color attachment for a render pass. |
GPURenderPassColorAttachment.Builder | Builder for |
GPURenderPassDepthStencilAttachment | Describes a depth-stencil attachment for a render pass. |
GPURenderPassDepthStencilAttachment.Builder | Builder for |
GPURenderPassDescriptor | Describes a render pass. |
GPURenderPassDescriptor.Builder | Builder for |
GPURenderPassEncoder | An object used to record commands for a render pass. |
GPURenderPassMaxDrawCount | An extension for specifying the maximum draw count in a render pass. |
GPURenderPipeline | A pipeline for rendering operations. |
GPURenderPipelineDescriptor | Describes a render pipeline. |
GPURenderPipelineDescriptor.Builder | Builder for |
GPURequestAdapterOptions | Options for requesting a graphics adapter. |
GPURequestAdapterOptions.Builder | Builder for |
GPURequestAdapterWebXROptions | Extension for WebXR interop options when requesting an adapter. |
GPUSampler | An object that controls how textures are sampled in a shader. |
GPUSamplerBindingLayout | Describes the layout of a sampler binding. |
GPUSamplerDescriptor | Describes a sampler. |
GPUSamplerDescriptor.Builder | Builder for |
GPUShaderModule | A compiled shader module. |
GPUShaderModuleDescriptor | Describes a shader module. |
GPUShaderSourceSPIRV | Extension for providing SPIR-V shader source code. |
GPUShaderSourceWGSL | Extension for providing WGSL shader source code. |
GPUStencilFaceState | Describes the stencil state for a single face of a primitive. |
GPUStencilFaceState.Builder | Builder for |
GPUStorageTextureBindingLayout | Describes the layout of a storage texture binding. |
GPUSupportedFeatures | A list of supported optional features. |
GPUSupportedInstanceFeatures | A list of supported optional instance features. |
GPUSupportedWGSLLanguageFeatures | A list of supported optional WGSL language features. |
GPUSurface | An object representing a platform-specific surface for rendering. |
GPUSurfaceCapabilities | Describes the capabilities of a surface for a given adapter. |
GPUSurfaceColorManagement | Extension for configuring color space and tone mapping for a surface. |
GPUSurfaceConfiguration | Describes the configuration for a surface. |
GPUSurfaceConfiguration.Builder | Builder for |
GPUSurfaceDescriptor | Describes a surface to be created. |
GPUSurfaceSourceAndroidNativeWindow | Extension for creating a surface from an Android ANativeWindow. |
GPUSurfaceTexture | Contains a texture to render to for a surface, along with status information. |
GPUTexelCopyBufferInfo | Describes a buffer used in a texel copy operation. |
GPUTexelCopyBufferLayout | Describes the layout of texel data within a buffer. |
GPUTexelCopyTextureInfo | Describes a texture used in a texel copy operation. |
GPUTexture | A GPU texture object. |
GPUTextureBindingLayout | Describes the layout of a texture binding. |
GPUTextureComponentSwizzle | Defines the mapping of source texture components to the color channels of a texture view, allowing for reordering or forcing values. |
GPUTextureComponentSwizzle.Builder | Builder for |
GPUTextureComponentSwizzleDescriptor | An extension chained to a texture view descriptor to define a custom component swizzle. |
GPUTextureDescriptor | Describes a texture to be created. |
GPUTextureDescriptor.Builder | Builder for |
GPUTextureView | A view into a texture, defining a specific sub-resource or reinterpretation of the texture's data. |
GPUTextureViewDescriptor | Describes a texture view. |
GPUTextureViewDescriptor.Builder | Builder for |
GPUVertexAttribute | Describes a single vertex attribute. |
GPUVertexBufferLayout | Describes the layout of a single vertex buffer. |
GPUVertexState | Describes the vertex shader stage of a render pipeline. |
Exceptions
CompilationInfoRequestException | |
CreatePipelineAsyncException | |
DawnException | Exception for errors originating from the Dawn WebGPU library that do not fit into more specific WebGPU error categories. |
DeviceLostException | Exception thrown when a |
InternalException | Exception for Internal type errors. |
MapAsyncException | |
OutOfMemoryException | Exception for OutOfMemory type errors. |
PopErrorScopeException | |
QueueWorkDoneException | |
RequestAdapterException | |
RequestDeviceException | |
SurfaceGetCurrentTextureException | |
UnknownException | Exception for Unknown type errors. |
ValidationException | Exception for Validation type errors. |
WebGpuException | |
WebGpuRuntimeException | Base class for exceptions that can happen at runtime. |
Objects
Top-level functions summary
suspend T | <T : Any?> awaitGPURequest(block: (callback: GPURequestCallback<T>) -> Unit) |
Top-level functions
awaitGPURequest
suspend fun <T : Any?> awaitGPURequest(block: (callback: GPURequestCallback<T>) -> Unit): T