@3dverse/api 0.8.20 → 0.8.21

package/dist/_prebuild/wrapper.d.ts

@@ -1476,7 +1476,7 @@ export type GetAssetDescription_Aabb = {
 };
 export type GetAssetDescription_RenderGraph = {
     /** All blend states */
-    blendStateDescriptions?: Array<GetAssetDescription_Object>;
+    blendStateDescriptions?: Array<GetAssetDescription_BlendState>;
     /** Descriptions of all buffers */
     bufferDescriptions?: Array<GetAssetDescription_Object>;
     /** Conditions referenced by conditionIndex */
@@ -1490,7 +1490,7 @@ export type GetAssetDescription_RenderGraph = {
     /** Name of the asset */
     name: string;
     /** Descriptions of all nodes */
-    nodeDataDescriptions: Array<StrictUnion<GetAssetDescription_Viewport | GetAssetDescription_DrawBatch | GetAssetDescription_DrawBatchWithMaterials | GetAssetDescription_DispatchCompute | GetAssetDescription_BlitImage | GetAssetDescription_DispatchPointClouds | GetAssetDescription_CopyImage | GetAssetDescription_ResolveImage | GetAssetDescription_DrawFullscreen | GetAssetDescription_GenerateMipChain | GetAssetDescription_CopyToCubemapFace | GetAssetDescription_ClearImages | GetAssetDescription_FillBuffer | GetAssetDescription_DrawDebugLines | GetAssetDescription_DispatchDecals | GetAssetDescription_SetDepthBias | GetAssetDescription_DispatchRayTracing> & GetAssetDescription_Object>;
+    nodeDataDescriptions: Array<StrictUnion<GetAssetDescription_Viewport | GetAssetDescription_DrawBatch | GetAssetDescription_DrawBatchWithMaterials | GetAssetDescription_DispatchCompute | GetAssetDescription_BlitImage | GetAssetDescription_DispatchPointClouds | GetAssetDescription_CopyImage | GetAssetDescription_ResolveImage | GetAssetDescription_DrawFullscreen | GetAssetDescription_BlitMipChain | GetAssetDescription_CopyToCubemapFace | GetAssetDescription_DispatchMipChain | GetAssetDescription_ClearImages | GetAssetDescription_FillBuffer | GetAssetDescription_DrawDebugLines | GetAssetDescription_DispatchDecals | GetAssetDescription_SetDepthBias | GetAssetDescription_DispatchRayTracing> & GetAssetDescription_Object>;
     /** The index of the render target used for occlusion */
     occlusionInputDepthRenderTargetIndex?: number;
     /** Descriptions of all render passes */
@@ -1504,6 +1504,24 @@ export type GetAssetDescription_RenderGraph = {
     /** Unique identifier for the asset */
     uuid: string;
 };
+export type GetAssetDescription_BlendState = {
+    /** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
+    alphaBlendOp?: number;
+    /** Controls whether blending is enabled for the corresponding color attachment. If blending is not enabled, the source fragment’s color for that attachment is passed through unmodified. */
+    blendEnable?: boolean;
+    /** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
+    colorBlendOp?: number;
+    /** Bitmask of VkColorComponentFlagBits specifying which of the R, G, B, and/or A components are enabled for writing, as described for the Color Write Mask. */
+    colorWriteMask?: number;
+    /** Selects which blend factor is used to determine the destination factor Da. */
+    dstAlphaBlendFactor?: number;
+    /** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
+    dstColorBlendFactor?: number;
+    /** Selects which blend factor is used to determine the source factor Sa. */
+    srcAlphaBlendFactor?: number;
+    /** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
+    srcColorBlendFactor?: number;
+};
 export type GetAssetDescription_Viewport = {
     type?: 0;
 };
@@ -1543,6 +1561,7 @@ export type GetAssetDescription_DispatchCompute = {
     type?: 3;
 };
 export type GetAssetDescription_BlitImage = {
+    filter?: number;
     /** Source render target */
     inputRenderTargetIndices?: Array<number>;
     /** Destination render target */
@@ -1583,9 +1602,12 @@ export type GetAssetDescription_DrawFullscreen = {
     shaderRef?: string;
     type?: 8;
 };
-export type GetAssetDescription_GenerateMipChain = {
+export type GetAssetDescription_BlitMipChain = {
+    filter?: number;
     /** Source render target */
     inputRenderTargetIndices?: Array<number>;
+    /** Mip generation mode */
+    mode?: StrictUnion<0 | 1> & number;
     type?: 9;
 };
 export type GetAssetDescription_CopyToCubemapFace = {
@@ -1593,6 +1615,19 @@ export type GetAssetDescription_CopyToCubemapFace = {
     inputRenderTargetIndices?: Array<number>;
     type?: 10;
 };
+export type GetAssetDescription_DispatchMipChain = {
+    /** Specialization constants values for the specified shader */
+    constantsJson?: object;
+    /** Data provided to the shader through the node data buffer */
+    dataJson?: object;
+    /** Source render target */
+    inputRenderTargetIndices?: Array<number>;
+    /** Mip generation mode */
+    mode?: StrictUnion<0 | 1> & number;
+    /** Unique identifier for the asset */
+    shaderRef?: string;
+    type?: 11;
+};
 export type GetAssetDescription_ClearImages = {
     /** Clear colors */
     clearColors?: Array<Array<number>>;
@@ -1653,7 +1688,7 @@ export type GetAssetDescription_ParameterDescriptor = {
     /** Categories */
     categories?: Array<string>;
     /** Parameter default value */
-    default?: StrictUnion<number | boolean | Array<number>>;
+    default?: number | boolean | Array<number>;
     /** Whether this parameter (a render target or buffer) is the resource used to compute the number of dispatched workgroups for a compute shader, i.e. DispatchedGroups = referenceResource.size / workgroupSize (see compute_shader_size_reference's reference_resource) */
     isReferenceResource?: boolean;
     /** Parameter name */
@@ -1662,8 +1697,10 @@ export type GetAssetDescription_ParameterDescriptor = {
     nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
     /** Parameter offset in bytes */
     offset: number;
+    /** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
+    properties?: GetAssetDescription_ParameterProperties;
     /** Parameter type */
-    type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
+    type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
 };
 export type GetAssetDescription_BufferProperties = {
     /** Number of elements in the buffer, or a [x, y] pair of factors applied to the viewport width and height (each rounded up and clamped to a minimum of 1, then multiplied) to compute the element count */
@@ -1673,6 +1710,14 @@ export type GetAssetDescription_BufferProperties = {
     /** How this buffer is going to be used */
     usage: number;
 };
+export type GetAssetDescription_ParameterProperties = {
+    /** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
+    format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
+    /** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
+    openMode?: 'read' | 'write' | 'readwrite';
+    /** Specialization constants gating this parameter's relevance: the key is a constant name, the value is what it must hold for the parameter to be relevant (e.g. shown in the material editor) */
+    spec?: GetAssetDescription_Object;
+};
 export type GetAssetDescription_Scene = {
     /** Bounding box in local space */
     aabb: GetAssetDescription_Aabb;
@@ -1706,6 +1751,8 @@ export type GetAssetDescription_Shader = {
     computeSettings?: GetAssetDescription_ComputeShaderSettings;
     /** Data descriptor for specialization constants */
     constantDescriptor?: Array<GetAssetDescription_SpecializationConstantDescriptor>;
+    /** GLSL extensions required by this shader, detected from the SPIR-V capabilities declared by its compiled modules */
+    glslExtensions?: Array<GetAssetDescription_GlslExtension>;
     /** Data descriptor for material shaders */
     materialDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
     /** Descriptions of all modules that compose this shader */
@@ -1718,6 +1765,8 @@ export type GetAssetDescription_Shader = {
     nodeDataDescriptorHash?: number;
     /** The size in byte of the compiled shader code (accumulated size of all modules) */
     payloadSize?: number;
+    /** Reference to the shader context associated with this shader. Only present for shaders that use one. */
+    shaderContextRef?: string;
     /** Vulkan bit mask of all shader stages present in this shader */
     shaderStages?: number;
     /** Unique identifier for the asset */
@@ -1735,7 +1784,7 @@ export type GetAssetDescription_ComputeShaderSettings = {
 };
 export type GetAssetDescription_SpecializationConstantDescriptor = {
     /** Constant default value */
-    default: StrictUnion<number | boolean>;
+    default: number | boolean;
     /** Description */
     description?: string;
     /** Display name */
@@ -1745,6 +1794,12 @@ export type GetAssetDescription_SpecializationConstantDescriptor = {
     /** Constant type */
     type: 'bool' | 'int' | 'uint' | 'float';
 };
+export type GetAssetDescription_GlslExtension = {
+    /** SPIR-V capability id that requires this extension (e.g. 5347 for PhysicalStorageBufferAddresses) */
+    capabilityId: number;
+    /** GLSL extension name, e.g. "GL_EXT_buffer_reference" */
+    name: string;
+};
 export type GetAssetDescription_ShaderModuleDescription = {
     /** Names of the bindings used by this module */
     bindings?: Array<string>;
@@ -1796,13 +1851,25 @@ export type GetAssetDescription_VertexAttributeDescriptor = {
     stride: number;
 };
 export type GetAssetDescription_ShaderContext = {
-    /** Data descriptor for this shader context */
+    /** The fields every shader in this family reads as input */
     dataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
     /** Name of the asset */
     name: string;
+    /** The fields a material shader must produce. */
+    outputDescriptor?: Array<GetAssetDescription_OutputFieldDescriptor>;
     /** Unique identifier for the asset */
     uuid: string;
 };
+export type GetAssetDescription_OutputFieldDescriptor = {
+    /** Blend state of the attachment, no blending if absent */
+    blendState?: GetAssetDescription_BlendState;
+    /** What this field represents */
+    description: string;
+    /** Field name */
+    name: string;
+    /** Field data type */
+    type: 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4';
+};
 export type GetAssetDescription_Skeleton = {
     /** Descriptions of all bones forming the skeleton */
     bones: Array<GetAssetDescription_Object>;
@@ -1912,7 +1979,7 @@ export type UpdateAssetDescription_Material = {
 };
 export type UpdateAssetDescription_RenderGraph = {
     /** All blend states */
-    blendStateDescriptions?: Array<UpdateAssetDescription_Object>;
+    blendStateDescriptions?: Array<UpdateAssetDescription_BlendState>;
     /** Descriptions of all buffers */
     bufferDescriptions?: Array<UpdateAssetDescription_Object>;
     /** Conditions referenced by conditionIndex */
@@ -1926,7 +1993,7 @@ export type UpdateAssetDescription_RenderGraph = {
     /** Name of the asset */
     name: string;
     /** Descriptions of all nodes */
-    nodeDataDescriptions: Array<StrictUnion<UpdateAssetDescription_Viewport | UpdateAssetDescription_DrawBatch | UpdateAssetDescription_DrawBatchWithMaterials | UpdateAssetDescription_DispatchCompute | UpdateAssetDescription_BlitImage | UpdateAssetDescription_DispatchPointClouds | UpdateAssetDescription_CopyImage | UpdateAssetDescription_ResolveImage | UpdateAssetDescription_DrawFullscreen | UpdateAssetDescription_GenerateMipChain | UpdateAssetDescription_CopyToCubemapFace | UpdateAssetDescription_ClearImages | UpdateAssetDescription_FillBuffer | UpdateAssetDescription_DrawDebugLines | UpdateAssetDescription_DispatchDecals | UpdateAssetDescription_SetDepthBias | UpdateAssetDescription_DispatchRayTracing> & UpdateAssetDescription_Object>;
+    nodeDataDescriptions: Array<StrictUnion<UpdateAssetDescription_Viewport | UpdateAssetDescription_DrawBatch | UpdateAssetDescription_DrawBatchWithMaterials | UpdateAssetDescription_DispatchCompute | UpdateAssetDescription_BlitImage | UpdateAssetDescription_DispatchPointClouds | UpdateAssetDescription_CopyImage | UpdateAssetDescription_ResolveImage | UpdateAssetDescription_DrawFullscreen | UpdateAssetDescription_BlitMipChain | UpdateAssetDescription_CopyToCubemapFace | UpdateAssetDescription_DispatchMipChain | UpdateAssetDescription_ClearImages | UpdateAssetDescription_FillBuffer | UpdateAssetDescription_DrawDebugLines | UpdateAssetDescription_DispatchDecals | UpdateAssetDescription_SetDepthBias | UpdateAssetDescription_DispatchRayTracing> & UpdateAssetDescription_Object>;
     /** The index of the render target used for occlusion */
     occlusionInputDepthRenderTargetIndex?: number;
     /** Descriptions of all render passes */
@@ -1938,24 +2005,34 @@ export type UpdateAssetDescription_RenderGraph = {
     /** All stencil states */
     stencilOpStateDescriptions?: Array<UpdateAssetDescription_Object>;
 };
-export type UpdateAssetDescription_Object = {
-    /** Alpha blend operator */
+export type UpdateAssetDescription_BlendState = {
+    /** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
     alphaBlendOp?: number;
-    /** Enable blending */
+    /** Controls whether blending is enabled for the corresponding color attachment. If blending is not enabled, the source fragment’s color for that attachment is passed through unmodified. */
     blendEnable?: boolean;
-    /** Color blend operator */
+    /** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
     colorBlendOp?: number;
-    /** Color write mask */
+    /** Bitmask of VkColorComponentFlagBits specifying which of the R, G, B, and/or A components are enabled for writing, as described for the Color Write Mask. */
     colorWriteMask?: number;
-    /** Destination alpha blend factor */
+    /** Selects which blend factor is used to determine the destination factor Da. */
     dstAlphaBlendFactor?: number;
-    /** Destination color blend factor */
+    /** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
     dstColorBlendFactor?: number;
-    /** Source alpha blend factor */
+    /** Selects which blend factor is used to determine the source factor Sa. */
     srcAlphaBlendFactor?: number;
-    /** Source color blend factor */
+    /** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
     srcColorBlendFactor?: number;
 };
+export type UpdateAssetDescription_Object = {
+    /** Number of elements in the buffer, or a [x, y] pair of factors applied to the viewport width and height (each rounded up and clamped to a minimum of 1, then multiplied) to compute the element count */
+    elementCount?: StrictUnion<number | Array<number>>;
+    /** Size in bytes of a single element in the buffer */
+    elementSize?: number;
+    /** Buffer name */
+    name?: string;
+    /** How this buffer is going to be used */
+    usage?: number;
+};
 export type UpdateAssetDescription_Viewport = {
     type?: 0;
 };
@@ -1991,6 +2068,7 @@ export type UpdateAssetDescription_DispatchCompute = {
     type?: 3;
 };
 export type UpdateAssetDescription_BlitImage = {
+    filter?: number;
     /** Source render target */
     inputRenderTargetIndices?: Array<number>;
     /** Destination render target */
@@ -2027,9 +2105,12 @@ export type UpdateAssetDescription_DrawFullscreen = {
     pipelineDescription?: UpdateAssetDescription_Object;
     type?: 8;
 };
-export type UpdateAssetDescription_GenerateMipChain = {
+export type UpdateAssetDescription_BlitMipChain = {
+    filter?: number;
     /** Source render target */
     inputRenderTargetIndices?: Array<number>;
+    /** Mip generation mode */
+    mode?: StrictUnion<0 | 1> & number;
     type?: 9;
 };
 export type UpdateAssetDescription_CopyToCubemapFace = {
@@ -2037,6 +2118,17 @@ export type UpdateAssetDescription_CopyToCubemapFace = {
     inputRenderTargetIndices?: Array<number>;
     type?: 10;
 };
+export type UpdateAssetDescription_DispatchMipChain = {
+    /** Specialization constants values for the specified shader */
+    constantsJson?: object;
+    /** Data provided to the shader through the node data buffer */
+    dataJson?: object;
+    /** Source render target */
+    inputRenderTargetIndices?: Array<number>;
+    /** Mip generation mode */
+    mode?: StrictUnion<0 | 1> & number;
+    type?: 11;
+};
 export type UpdateAssetDescription_ClearImages = {
     /** Clear colors */
     clearColors?: Array<Array<number>>;
@@ -2093,7 +2185,7 @@ export type UpdateAssetDescription_ParameterDescriptor = {
     /** Categories */
     categories?: Array<string>;
     /** Parameter default value */
-    default?: StrictUnion<number | boolean | Array<number>>;
+    default?: number | boolean | Array<number>;
     /** Whether this parameter (a render target or buffer) is the resource used to compute the number of dispatched workgroups for a compute shader, i.e. DispatchedGroups = referenceResource.size / workgroupSize (see compute_shader_size_reference's reference_resource) */
     isReferenceResource?: boolean;
     /** Parameter name */
@@ -2102,8 +2194,10 @@ export type UpdateAssetDescription_ParameterDescriptor = {
     nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
     /** Parameter offset in bytes */
     offset: number;
+    /** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
+    properties?: UpdateAssetDescription_ParameterProperties;
     /** Parameter type */
-    type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
+    type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
 };
 export type UpdateAssetDescription_BufferProperties = {
     /** Number of elements in the buffer, or a [x, y] pair of factors applied to the viewport width and height (each rounded up and clamped to a minimum of 1, then multiplied) to compute the element count */
@@ -2113,6 +2207,14 @@ export type UpdateAssetDescription_BufferProperties = {
     /** How this buffer is going to be used */
     usage: number;
 };
+export type UpdateAssetDescription_ParameterProperties = {
+    /** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
+    format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
+    /** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
+    openMode?: 'read' | 'write' | 'readwrite';
+    /** Specialization constants gating this parameter's relevance: the key is a constant name, the value is what it must hold for the parameter to be relevant (e.g. shown in the material editor) */
+    spec?: UpdateAssetDescription_Object;
+};
 /**
  * Updates the description of the specified asset.
  */