Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update gpuweb: Add "read-write" and "write-only" storage texture access #144

Merged
merged 5 commits into from
Nov 16, 2023
Merged

Update gpuweb: Add "read-write" and "write-only" storage texture access #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
73e23a0
Update gpuweb: Add "read-write" and "read-only" as new storage textur…
Jiawei-Shao Nov 15, 2023
a2b75c1
0.1.39
Jiawei-Shao Nov 15, 2023
e5bb19b
Include copies.bs in index.bs
Jiawei-Shao Nov 16, 2023
159df73
Add the diff in generated/index.d.ts to dist/index.d.ts
Jiawei-Shao Nov 16, 2023
bbd5e83
Revert "0.1.39"
Jiawei-Shao Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions dist/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,10 @@ type GPUStencilOperation =
| "increment-wrap"
| "decrement-wrap";
type GPUStorageTextureAccess =
"write-only";

| "write-only"
| "read-only"
| "read-write";
type GPUStoreOp =

| "store"
Expand Down Expand Up @@ -1116,6 +1119,11 @@ interface GPURenderPassColorAttachment {
* color attachment.
*/
view: GPUTextureView;
/**
* Indicates the depth slice index of {@link GPUTextureViewDimension#"3d"} {@link GPURenderPassColorAttachment#view}
* that will be output to for this color attachment.
*/
depthSlice?: GPUIntegerCoordinate;
/**
* A {@link GPUTextureView} describing the texture subresource that will receive the resolved
* output for this color attachment if {@link GPURenderPassColorAttachment#view} is
Expand Down Expand Up @@ -1382,6 +1390,7 @@ interface GPUSamplerDescriptor
}

interface GPUShaderModuleCompilationHint {
entryPoint: string;
/**
* A {@link GPUPipelineLayout} that the {@link GPUShaderModule} may be used with in a future
* {@link GPUDevice#createComputePipeline()} or {@link GPUDevice#createRenderPipeline} call.
Expand All @@ -1407,25 +1416,31 @@ interface GPUShaderModuleDescriptor
* WGSL names (identifiers) in source maps follow the rules defined in WGSL identifier
* comparison.
*/
sourceMap?: object;
sourceMap?: any;
/**
* If defined maps an entry point name from the shader to a {@link GPUShaderModuleCompilationHint}.
* No validation is performed with any of these {@link GPUShaderModuleCompilationHint}.
* Implementations should use any information present in the {@link GPUShaderModuleCompilationHint}
* A list of {@link GPUShaderModuleCompilationHint}s.
* Any hint provided by an application **should** contain information about one entry point of
* a pipeline that will eventually be created from the entry point.
* Implementations **should** use any information present in the {@link GPUShaderModuleCompilationHint}
* to perform as much compilation as is possible within {@link GPUDevice#createShaderModule}.
* Entry point names follow the rules defined in WGSL identifier comparison.
* Note: Supplying information in {@link GPUShaderModuleDescriptor#hints} does not have any
* observable effect, other than performance. Because a single shader module can hold
* Aside from type-checking, these hints are not validated in any way.
* <div class=note heading>
* Supplying information in {@link GPUShaderModuleDescriptor#compilationHints} does not have any
* observable effect, other than performance. It may be detrimental to performance to
* provide hints for pipelines that never end up being created.
* Because a single shader module can hold
* multiple entry points, and multiple pipelines can be created from a single shader
* module, it can be more performant for an implementation to do as much compilation as
* possible once in {@link GPUDevice#createShaderModule} rather than multiple times in
* the multiple calls to {@link GPUDevice#createComputePipeline} /
* the multiple calls to {@link GPUDevice#createComputePipeline} or
* {@link GPUDevice#createRenderPipeline}.
* </div>
* Note:
* Hints are not validated in an observable way, but user agents **may** surface identifiable
* errors (like unknown entry point names or incompatible pipeline layouts) to developers,
* for example in the browser developer console.
*/
hints?: Record<
string,
GPUShaderModuleCompilationHint
>;
compilationHints?: Array<GPUShaderModuleCompilationHint>;
}

interface GPUStencilFaceState {
Expand Down Expand Up @@ -1454,9 +1469,6 @@ interface GPUStencilFaceState {
interface GPUStorageTextureBindingLayout {
/**
* The access mode for this binding, indicating readability and writability.
* Note:
* There is currently only one access mode, {@link GPUStorageTextureAccess#"write-only"},
* but this will expand in the future.
*/
access?: GPUStorageTextureAccess;
/**
Expand Down Expand Up @@ -1517,8 +1529,7 @@ interface GPUTextureDescriptor
* Specifies what view {@link GPUTextureViewDescriptor#format} values will be allowed when calling
* {@link GPUTexture#createView} on this texture (in addition to the texture's actual
* {@link GPUTextureDescriptor#format}).
* <div class=note>
* Note:
* <div class=note heading>
* Adding a format to this list may have a significant performance impact, so it is best
* to avoid adding formats unnecessarily.
* The actual performance impact is highly dependent on the target system; developers must
Expand Down Expand Up @@ -2144,17 +2155,6 @@ interface GPUCommandEncoder
offset?: GPUSize64,
size?: GPUSize64
): undefined;
/**
* Writes a timestamp value into a querySet when all previous commands have completed executing.
* Note: Timestamp query values are written in nanoseconds, but how the value is determined is
* implementation-defined and may not increase monotonically. See [[#timestamp]] for details.
* @param querySet - The query set that will store the timestamp values.
* @param queryIndex - The index of the query in the query set.
*/
writeTimestamp(
querySet: GPUQuerySet,
queryIndex: GPUSize32
): undefined;
/**
* Resolves query results from a {@link GPUQuerySet} out into a range of a {@link GPUBuffer}.
* querySet:
Expand Down Expand Up @@ -2211,7 +2211,7 @@ interface GPUCompilationMessage {
* Note: The {@link GPUCompilationMessage#message} should follow the best practices for language
* and direction information. This includes making use of any future standards which may
* emerge regarding the reporting of string language and direction metadata.
* <p class="note editorial">Editorial:
* <p class="note editorial"><span class=marker>Editorial note:</span>
* At the time of this writing, no language/direction recommendation is available that provides
* compatibility and consistency with legacy APIs, but when there is, adopt it formally.
*/
Expand Down Expand Up @@ -2541,7 +2541,7 @@ interface GPUError {
* Note: The {@link GPUError#message} should follow the best practices for language and
* direction information. This includes making use of any future standards which may emerge
* regarding the reporting of string language and direction metadata.
* <p class="note editorial">Editorial:
* <p class="note editorial"><span class=marker>Editorial note:</span>
* At the time of this writing, no language/direction recommendation is available that provides
* compatibility and consistency with legacy APIs, but when there is, adopt it formally.
*/
Expand Down
60 changes: 30 additions & 30 deletions generated/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,10 @@ type GPUStencilOperation =
| "increment-wrap"
| "decrement-wrap";
type GPUStorageTextureAccess =
"write-only";

| "write-only"
| "read-only"
| "read-write";
type GPUStoreOp =

| "store"
Expand Down Expand Up @@ -1104,6 +1107,11 @@ interface GPURenderPassColorAttachment {
* color attachment.
*/
view: GPUTextureView;
/**
* Indicates the depth slice index of {@link GPUTextureViewDimension#"3d"} {@link GPURenderPassColorAttachment#view}
* that will be output to for this color attachment.
*/
depthSlice?: GPUIntegerCoordinate;
Jiawei-Shao marked this conversation as resolved.
Show resolved Hide resolved
/**
* A {@link GPUTextureView} describing the texture subresource that will receive the resolved
* output for this color attachment if {@link GPURenderPassColorAttachment#view} is
Expand Down Expand Up @@ -1341,6 +1349,7 @@ interface GPUSamplerDescriptor
}

interface GPUShaderModuleCompilationHint {
entryPoint: string;
Jiawei-Shao marked this conversation as resolved.
Show resolved Hide resolved
/**
* A {@link GPUPipelineLayout} that the {@link GPUShaderModule} may be used with in a future
* {@link GPUDevice#createComputePipeline()} or {@link GPUDevice#createRenderPipeline} call.
Expand Down Expand Up @@ -1368,23 +1377,29 @@ interface GPUShaderModuleDescriptor
*/
sourceMap?: any;
/**
* If defined maps an entry point name from the shader to a {@link GPUShaderModuleCompilationHint}.
* No validation is performed with any of these {@link GPUShaderModuleCompilationHint}.
* Implementations should use any information present in the {@link GPUShaderModuleCompilationHint}
* A list of {@link GPUShaderModuleCompilationHint}s.
* Any hint provided by an application **should** contain information about one entry point of
* a pipeline that will eventually be created from the entry point.
* Implementations **should** use any information present in the {@link GPUShaderModuleCompilationHint}
* to perform as much compilation as is possible within {@link GPUDevice#createShaderModule}.
* Entry point names follow the rules defined in WGSL identifier comparison.
* Note: Supplying information in {@link GPUShaderModuleDescriptor#hints} does not have any
* observable effect, other than performance. Because a single shader module can hold
* Aside from type-checking, these hints are not validated in any way.
* <div class=note heading>
* Supplying information in {@link GPUShaderModuleDescriptor#compilationHints} does not have any
* observable effect, other than performance. It may be detrimental to performance to
* provide hints for pipelines that never end up being created.
* Because a single shader module can hold
* multiple entry points, and multiple pipelines can be created from a single shader
* module, it can be more performant for an implementation to do as much compilation as
* possible once in {@link GPUDevice#createShaderModule} rather than multiple times in
* the multiple calls to {@link GPUDevice#createComputePipeline} /
* the multiple calls to {@link GPUDevice#createComputePipeline} or
* {@link GPUDevice#createRenderPipeline}.
* </div>
* Note:
* Hints are not validated in an observable way, but user agents **may** surface identifiable
* errors (like unknown entry point names or incompatible pipeline layouts) to developers,
* for example in the browser developer console.
*/
hints?: Record<
string,
GPUShaderModuleCompilationHint
>;
compilationHints?: Array<GPUShaderModuleCompilationHint>;
Jiawei-Shao marked this conversation as resolved.
Show resolved Hide resolved
}

interface GPUStencilFaceState {
Expand Down Expand Up @@ -1413,9 +1428,6 @@ interface GPUStencilFaceState {
interface GPUStorageTextureBindingLayout {
/**
* The access mode for this binding, indicating readability and writability.
* Note:
* There is currently only one access mode, {@link GPUStorageTextureAccess#"write-only"},
* but this will expand in the future.
*/
access?: GPUStorageTextureAccess;
/**
Expand Down Expand Up @@ -1476,8 +1488,7 @@ interface GPUTextureDescriptor
* Specifies what view {@link GPUTextureViewDescriptor#format} values will be allowed when calling
* {@link GPUTexture#createView} on this texture (in addition to the texture's actual
* {@link GPUTextureDescriptor#format}).
* <div class=note>
* Note:
* <div class=note heading>
* Adding a format to this list may have a significant performance impact, so it is best
* to avoid adding formats unnecessarily.
* The actual performance impact is highly dependent on the target system; developers must
Expand Down Expand Up @@ -2051,17 +2062,6 @@ interface GPUCommandEncoder
offset?: GPUSize64,
size?: GPUSize64
): undefined;
/**
* Writes a timestamp value into a querySet when all previous commands have completed executing.
* Note: Timestamp query values are written in nanoseconds, but how the value is determined is
* implementation-defined and may not increase monotonically. See [[#timestamp]] for details.
* @param querySet - The query set that will store the timestamp values.
* @param queryIndex - The index of the query in the query set.
*/
writeTimestamp(
Jiawei-Shao marked this conversation as resolved.
Show resolved Hide resolved
querySet: GPUQuerySet,
queryIndex: GPUSize32
): undefined;
/**
* Resolves query results from a {@link GPUQuerySet} out into a range of a {@link GPUBuffer}.
* querySet:
Expand Down Expand Up @@ -2116,7 +2116,7 @@ interface GPUCompilationMessage {
* Note: The {@link GPUCompilationMessage#message} should follow the best practices for language
* and direction information. This includes making use of any future standards which may
* emerge regarding the reporting of string language and direction metadata.
* <p class="note editorial">Editorial:
* <p class="note editorial"><span class=marker>Editorial note:</span>
* At the time of this writing, no language/direction recommendation is available that provides
* compatibility and consistency with legacy APIs, but when there is, adopt it formally.
*/
Expand Down Expand Up @@ -2436,7 +2436,7 @@ interface GPUError {
* Note: The {@link GPUError#message} should follow the best practices for language and
* direction information. This includes making use of any future standards which may emerge
* regarding the reporting of string language and direction metadata.
* <p class="note editorial">Editorial:
* <p class="note editorial"><span class=marker>Editorial note:</span>
* At the time of this writing, no language/direction recommendation is available that provides
* compatibility and consistency with legacy APIs, but when there is, adopt it formally.
*/
Expand Down
2 changes: 1 addition & 1 deletion gpuweb
Open in desktop
Submodule gpuweb updated 3 files
+96 −0 proposals/compatibility-mode.md
+279 −188 spec/index.bs
+127 −19 wgsl/index.bs
Loading