gpu: add TODOs about documentation

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2022-03-07 22:44:10 -07:00 committed by Stephen Gutekanst
parent 818a2a172c
commit 070126b85d
4 changed files with 8 additions and 1 deletions

View file

@ -95,6 +95,7 @@ pub const Type = enum(u32) {
unknown, unknown,
}; };
// TODO: docs
pub fn typeName(t: Type) []const u8 { pub fn typeName(t: Type) []const u8 {
return switch (t) { return switch (t) {
.discrete_gpu => "Discrete GPU", .discrete_gpu => "Discrete GPU",
@ -116,6 +117,7 @@ pub const BackendType = enum(u32) {
opengles, opengles,
}; };
// TODO: docs
pub fn backendTypeName(t: BackendType) []const u8 { pub fn backendTypeName(t: BackendType) []const u8 {
return switch (t) { return switch (t) {
.nul => "Null", .nul => "Null",

View file

@ -52,6 +52,7 @@ pub const VTable = struct {
release: fn (ptr: *anyopaque) void, release: fn (ptr: *anyopaque) void,
}; };
// TODO: docs
pub const Descriptor = struct { pub const Descriptor = struct {
label: ?[]const u8 = null, label: ?[]const u8 = null,
required_features: ?[]FeatureName = null, required_features: ?[]FeatureName = null,

View file

@ -29,6 +29,7 @@ pub const DescriptorTag = enum {
canvas_html_selector, canvas_html_selector,
}; };
// TODO: docs
pub const Descriptor = union(DescriptorTag) { pub const Descriptor = union(DescriptorTag) {
metal_layer: struct { metal_layer: struct {
label: ?[]const u8, label: ?[]const u8,

View file

@ -14,7 +14,10 @@
//! //!
//! Note: WebGPUs coordinate systems match DirectXs coordinate systems in a graphics pipeline. //! Note: WebGPUs coordinate systems match DirectXs coordinate systems in a graphics pipeline.
//! //!
//! //! # Reference counting
//!
//! TODO: docs
//!
const std = @import("std"); const std = @import("std");
pub const Interface = @import("Interface.zig"); pub const Interface = @import("Interface.zig");
pub const RequestAdapterOptions = Interface.RequestAdapterOptions; pub const RequestAdapterOptions = Interface.RequestAdapterOptions;