aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordan sinclair <dsinclair@google.com>2019-05-09 16:48:40 -0400
committerGitHub <noreply@github.com>2019-05-09 16:48:40 -0400
commitc5465245af2320d5f0a0e83d3ba4c2f718cc56a9 (patch)
tree22109b570aba97c151514f8c0a4291eca6bc108e /docs
parent203a9902f1a77e2f9d25828df681ba1efb56dc31 (diff)
downloadamber-c5465245af2320d5f0a0e83d3ba4c2f718cc56a9.tar.gz
Update VkScript buffer document. (#500)
This CL updates the VkScript document to make note that buffers must be given consistent types. Fixes #497
Diffstat (limited to 'docs')
-rw-r--r--docs/vk_script.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/vk_script.md b/docs/vk_script.md
index 07c75eb..78e2523 100644
--- a/docs/vk_script.md
+++ b/docs/vk_script.md
@@ -213,6 +213,9 @@ Sets the push constants at `offset`. The `type` is from the *Data Types*
section below. The `values` must be a non-zero multiple of the requested
`type`.
+When setting push constant data each call to `uniform` must use the same
+`type` or the script will be rejected as invalid.
+
### Unifom UBO
* `uniform ubo _binding_ _type_ _offset_ _values_+`
@@ -221,6 +224,9 @@ Sets the values in the uniform buffer at `binding` and `offset`. The `type`
is from the *Data Types* section below. The `values` must be a non-zero
multiple of the requested `type`.
+When setting data into a single `binding`, each call to `uniform ubo` must
+use the same `type` or the script will be rejected as invalid.
+
### SSBO size
* `ssbo _binding_ _size_`
@@ -235,6 +241,9 @@ Sets the value of the buffer at `binding` and `offset`. The `type` is from the
*Data Types* section below. The `values` must be a non-zero multiple of the
requested `type`. The offset must be a multiple of the _type_ size in bytes.
+When setting data into a single `binding`, each call to `ssbo subdata` must
+use the same `type` or the script will be rejected as invalid.
+
### Patch Parameters
* `patch parameter vertices _count_`