src/dawn/dawn_wire.json

{
    "_comment": [
        "Copyright 2019 The Dawn & Tint Authors",
        "",
        "Redistribution and use in source and binary forms, with or without",
        "modification, are permitted provided that the following conditions are met:",
        "",
        "  1. Redistributions of source code must retain the above copyright notice, this",
        "     list of conditions and the following disclaimer.",
        "",
        "  2. Redistributions in binary form must reproduce the above copyright notice,",
        "     this list of conditions and the following disclaimer in the documentation",
        "     and/or other materials provided with the distribution.",
        "",
        "  3. Neither the name of the copyright holder nor the names of its",
        "     contributors may be used to endorse or promote products derived from",
        "     this software without specific prior written permission.",
        "  ",
        "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"",
        "AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE",
        "IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE",
        "DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE",
        "FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL",
        "DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR",
        "SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER",
        "CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,",
        "OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE",
        "OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
    ],

    "_doc": "See docs/dawn/codegen.md",

    "commands": {
        "buffer map async": [
            { "name": "buffer id", "type": "ObjectId", "id_type": "buffer" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "mode", "type": "map mode" },
            { "name": "offset", "type": "size_t"},
            { "name": "size", "type": "size_t"}
        ],
        "buffer update mapped data": [
            { "name": "buffer id", "type": "ObjectId", "id_type": "buffer" },
            { "name": "data update info length", "type": "size_t" },
            { "name": "data update info", "type": "std::byte", "annotation": "const*", "length": "data update info length", "skip_serialize": true},
            { "name": "offset", "type": "size_t"},
            { "name": "size", "type": "size_t"}
        ],
        "device create buffer": [
            { "name": "device id", "type": "ObjectId", "id_type": "device" },
            { "name": "descriptor", "type": "buffer descriptor", "annotation": "const*" },
            { "name": "result", "type": "ObjectHandle", "handle_type": "buffer" },
            { "name": "memory handle create info length", "type": "size_t" },
            { "name": "memory handle create info", "type": "std::byte", "annotation": "const*", "length": "memory handle create info length", "skip_serialize": true}
        ],
        "device create compute pipeline async": [
            { "name": "device id", "type": "ObjectId", "id_type": "device"},
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "pipeline object handle", "type": "ObjectHandle", "handle_type": "compute pipeline"},
            { "name": "descriptor", "type": "compute pipeline descriptor", "annotation": "const*"}
        ],
        "device create render pipeline async": [
            { "name": "device id", "type": "ObjectId", "id_type": "device" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "pipeline object handle", "type": "ObjectHandle", "handle_type": "render pipeline"},
            { "name": "descriptor", "type": "render pipeline descriptor", "annotation": "const*"}
        ],
        "device pop error scope": [
            { "name": "device id", "type": "ObjectId", "id_type": "device" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" }
        ],
        "unregister object": [
            { "name": "object type", "type": "ObjectType" },
            { "name": "object id", "type": "ObjectId" }
        ],
        "queue on submitted work done": [
            { "name": "queue id", "type": "ObjectId", "id_type": "queue" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" }
        ],
        "queue write buffer": [
            { "name": "queue id", "type": "ObjectId", "id_type": "queue" },
            { "name": "buffer id", "type": "ObjectId", "id_type": "buffer" },
            { "name": "buffer offset", "type": "uint64_t"},
            {"name": "data", "type": "uint8_t", "annotation": "const*", "length": "size", "wire_is_data_only": true},
            {"name": "size", "type": "size_t"}
        ],
        "queue write buffer xl": [
            { "name": "queue id", "type": "ObjectId", "id_type": "queue" },
            { "name": "buffer id", "type": "ObjectId", "id_type": "buffer" },
            { "name": "buffer offset", "type": "uint64_t"},
            { "name": "size", "type": "size_t"},
            { "name": "memory handle create info length", "type": "size_t" },
            { "name": "memory handle create info", "type": "std::byte", "annotation": "const*", "length": "memory handle create info length", "skip_serialize": true},
            { "name": "memory data update info length", "type": "size_t" },
            { "name": "memory data update info", "type": "std::byte", "annotation": "const*", "length": "memory data update info length", "skip_serialize": true}
        ],
        "queue write texture": [
            {"name": "queue id", "type": "ObjectId", "id_type": "queue" },
            {"name": "destination", "type": "texel copy texture info", "annotation": "const*"},
            {"name": "data", "type": "uint8_t", "annotation": "const*", "length": "data size", "wire_is_data_only": true},
            {"name": "data size", "type": "size_t"},
            {"name": "data layout", "type": "texel copy buffer layout", "annotation": "const*"},
            {"name": "writeSize", "type": "extent 3D", "annotation": "const*"}
        ],
        "queue write texture xl": [
            { "name": "queue id", "type": "ObjectId", "id_type": "queue" },
            { "name": "destination", "type": "texel copy texture info", "annotation": "const*"},
            { "name": "data size", "type": "size_t"},
            { "name": "data layout", "type": "texel copy buffer layout", "annotation": "const*"},
            { "name": "writeSize", "type": "extent 3D", "annotation": "const*"},
            { "name": "memory handle create info length", "type": "size_t" },
            { "name": "memory handle create info", "type": "std::byte", "annotation": "const*", "length": "memory handle create info length", "skip_serialize": true},
            { "name": "memory data update info length", "type": "size_t" },
            { "name": "memory data update info", "type": "std::byte", "annotation": "const*", "length": "memory data update info length", "skip_serialize": true}
        ],
        "shader module get compilation info": [
            { "name": "shader module id", "type": "ObjectId", "id_type": "shader module" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" }
        ],
        "surface get current texture": [
            { "name": "surface id", "type": "ObjectId", "id_type": "surface" },
            { "name": "configured device id", "type": "ObjectId", "id_type": "device" },
            { "name": "texture handle", "type": "ObjectHandle", "handle_type": "texture" }
        ],
        "instance request adapter": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "adapter object handle", "type": "ObjectHandle", "handle_type": "adapter"},
            { "name": "options", "type": "request adapter options", "annotation": "const*", "optional": true }
        ],
        "adapter request device": [
            { "name": "adapter id", "type": "ObjectId", "id_type": "adapter" },
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "device object handle", "type": "ObjectHandle", "handle_type": "device"},
            { "name": "device lost future", "type": "future" },
            { "name": "descriptor", "type": "device descriptor", "annotation": "const*" }
        ],
        "render pass encoder set immediates": [
            { "name": "render pass encoder id", "type": "ObjectId", "id_type": "render pass encoder"},
            { "name": "offset", "type": "uint32_t"},
            { "name": "data", "type": "uint8_t", "annotation": "const*", "length": "size", "wire_is_data_only": true},
            { "name": "size", "type": "size_t"}
        ],
        "render bundle encoder set immediates": [
            { "name": "render bundle encoder id", "type": "ObjectId", "id_type": "render bundle encoder"},
            {"name": "offset", "type": "uint32_t"},
            { "name": "data", "type": "uint8_t", "annotation": "const*", "length": "size", "wire_is_data_only": true},
            { "name": "size", "type": "size_t"}
        ],
        "compute pass encoder set immediates": [
            { "name": "compute pass encoder id", "type": "ObjectId", "id_type": "compute pass encoder"},
            { "name": "offset", "type": "uint32_t"},
            { "name": "data", "type": "uint8_t", "annotation": "const*", "length": "size", "wire_is_data_only": true},
            { "name": "size", "type": "size_t"}
        ]
    },
    "return commands": {
        "buffer map async callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "map async status" },
            { "name": "message", "type": "string view" },
            { "name": "read data update info length", "type": "size_t" },
            { "name": "read data update info", "type": "std::byte", "annotation": "const*", "length": "read data update info length", "skip_serialize": true }
        ],
        "device create compute pipeline async callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "create pipeline async status" },
            { "name": "message", "type": "string view"}
        ],
        "device create render pipeline async callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "create pipeline async status" },
            { "name": "message", "type": "string view"}
        ],
        "device uncaptured error callback": [
            { "name": "device", "type": "ObjectHandle", "handle_type": "device" },
            { "name": "type", "type": "error type"},
            { "name": "message", "type": "string view"}
        ],
        "device logging callback": [
            { "name": "device", "type": "ObjectHandle", "handle_type": "device" },
            { "name": "type", "type": "logging type"},
            { "name": "message", "type": "string view" }
        ],
        "device lost callback" : [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "reason", "type": "device lost reason" },
            { "name": "message", "type": "string view"}
        ],
        "device pop error scope callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "pop error scope status" },
            { "name": "type", "type": "error type" },
            { "name": "message", "type": "string view"}
        ],
        "queue work done callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "queue work done status" },
            { "name": "message", "type": "string view" }
        ],
        "shader module get compilation info callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "compilation info request status" },
            { "name": "info", "type": "compilation info", "annotation": "const*", "optional": true }
        ],
        "instance request adapter callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "request adapter status" },
            { "name": "message", "type": "string view" },
            { "name": "info", "type": "adapter info", "annotation": "const*", "optional": "true" },
            { "name": "limits", "type": "limits", "annotation": "const*", "optional": "true" },
            { "name": "features count", "type": "uint32_t"},
            { "name": "features", "type": "feature name", "annotation": "const*", "length": "features count"}
        ],
        "adapter request device callback": [
            { "name": "instance id", "type": "ObjectId", "id_type": "instance" },
            { "name": "future", "type": "future" },
            { "name": "status", "type": "request device status" },
            { "name": "message", "type": "string view" },
            { "name": "limits", "type": "limits", "annotation": "const*", "optional": "true" },
            { "name": "features count", "type": "uint32_t"},
            { "name": "features", "type": "feature name", "annotation": "const*", "length": "features count"}
        ]
    },
    "special commands": {
        "chunked command": [
            {"name": "id", "type": "uint64_t"},
            {"name": "size", "type": "size_t"},
            {"name": "chunk data", "type": "std::byte", "annotation": "const*", "length": "chunk size", "wire_is_data_only": true},
            {"name": "chunk size", "type": "size_t"}
        ]
    },
    "special items": {
        "client_side_structures": [
            "FutureWaitInfo",
            "SurfaceDescriptorFromWindowsCoreWindow",
            "SurfaceDescriptorFromWindowsUWPSwapChainPanel",
            "SurfaceDescriptorFromWindowsWinUISwapChainPanel",
            "SurfaceSourceMetalLayer",
            "SurfaceSourceWindowsHWND",
            "SurfaceSourceXlibWindow",
            "SurfaceSourceWaylandSurface",
            "SurfaceSourceAndroidNativeWindow",
            "SurfaceSourceXCBWindow"
        ],
        "client_side_commands": [
            "AdapterCreateDevice",
            "AdapterGetFeatures",
            "AdapterGetFormatCapabilities",
            "AdapterGetInfo",
            "AdapterGetInstance",
            "AdapterGetLimits",
            "AdapterHasFeature",
            "AdapterRequestDevice",
            "BufferMapAsync",
            "BufferGetConstMappedRange",
            "BufferGetMappedRange",
            "BufferReadMappedRange",
            "BufferWriteMappedRange",
            "BufferGetMapState",
            "BufferGetSize",
            "BufferGetUsage",
            "ComputePassEncoderSetImmediates",
            "DeviceCreateBuffer",
            "DeviceCreateComputePipelineAsync",
            "DeviceCreateRenderPipelineAsync",
            "DeviceGetAdapter",
            "DeviceGetAdapterInfo",
            "DeviceGetFeatures",
            "DeviceGetLimits",
            "DeviceGetLostFuture",
            "DeviceHasFeature",
            "DevicePopErrorScope",
            "DeviceSetLoggingCallback",
            "InstanceGetWGSLLanguageFeatures",
            "InstanceHasWGSLLanguageFeature",
            "InstanceCreateSurface",
            "InstanceRequestAdapter",
            "QuerySetGetType",
            "QuerySetGetCount",
            "QueueOnSubmittedWorkDone",
            "QueueWriteBuffer",
            "QueueWriteTexture",
            "RenderBundleEncoderSetImmediates",
            "RenderPassEncoderSetImmediates",
            "ResourceTableGetSize",
            "ResourceTableInsert",
            "ShaderModuleGetCompilationInfo",
            "SurfaceGetCapabilities",
            "SurfaceGetCurrentTexture",
            "SurfaceGetPreferredFormat",
            "TextureGetWidth",
            "TextureGetHeight",
            "TextureGetDepthOrArrayLayers",
            "TextureGetMipLevelCount",
            "TextureGetSampleCount",
            "TextureGetDimension",
            "TextureGetFormat",
            "TextureGetUsage",
            "TextureGetTextureBindingViewDimension"
        ],
        "client_handwritten_commands": [
            "AdapterGetInstance",
            "BufferDestroy",
            "BufferUnmap",
            "DeviceCreateErrorBuffer",
            "DeviceCreateErrorTexture",
            "DeviceCreateResourceTable",
            "DeviceCreateTexture",
            "DeviceDestroy",
            "DeviceGetQueue",
            "DeviceGetSupportedSurfaceUsage",
            "DeviceInjectError",
            "InstanceProcessEvents",
            "InstanceWaitAny",
            "QueueSubmit",
            "ResourceTableDestroy",
            "ResourceTableRemove",
            "ResourceTableUpdate",
            "SurfaceConfigure",
            "SurfacePresent",
            "SurfaceUnconfigure"
        ],
        "client_special_objects": [
            "Adapter",
            "Buffer",
            "Device",
            "Instance",
            "QuerySet",
            "Queue",
            "ResourceTable",
            "ShaderModule",
            "Surface",
            "SurfaceCapabilities",
            "Texture",
            "RenderPassEncoder",
            "RenderBundleEncoder",
            "ComputePassEncoder"
        ],
        "server_custom_pre_handler_commands": [
            "DeviceCreateErrorBuffer",
            "BufferDestroy",
            "BufferUnmap"
        ]
    }
}