@3dverse/api 0.8.20 → 0.8.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -508,15 +508,7 @@ export type UploadSourceFiles_Object = {
508
508
  upload_task_id?: string;
509
509
  };
510
510
  /**
511
- * Uploads the specified source file(s).
512
- * The supported file formats are:
513
- * - Scene :
514
- * - Mesh : `fbx, obj/mtl, stl, ply, ifc, usd, usda, usdc, usdz, skp, ptf, 3ds, 3mf, ac, ac3d, acc, amj, ase, ask, b3d, blend, bvh, cms, cob, dae, dxf, gltf/bin, glb, enff, hmb, irr, irrmesh, lwo, lws, lxo, m3d, md2, md3, md5, mdc, mdl, xml, mot, ms3d, ndo, nff, off, ogex, pmx, prj, q3o, q3s, raw, scn, sib, smd, ter, uc, vta, wrl, x, x3d, xgl, zgl`
515
- * - Point cloud : `e57, ptx, xyz, las, laz`
516
- * - Volume : `dcm`
517
- * - Texture : `jpg, jpeg, png, tga, dds, tif, tiff, bmp, rgbe`
518
- * - Cubemap : `hdr`
519
- * - Sound : `wav, mp3, ogg, flac`.
511
+ * Uploads the specified source file(s). The accepted extensions, their conversion type and per-converter options are listed by `GET /source-files/supported-formats` and documented at https://docs.3dverse.com/references/supported-file-formats.
520
512
  */
521
513
  export declare function uploadSourceFiles({ folder_id, body, }: {
522
514
  folder_id: string;
@@ -729,7 +721,8 @@ export declare function createCubemap({ folder_id, faces, name, }: {
729
721
  export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
730
722
  /** List of asset ids contained in the package */
731
723
  asset_ids: ImportAssets_AssetIds;
732
- /** List of skipped file names in the package */
724
+ /** List of skipped file names in the package. Includes the payload files of shader, script and animation_sequence assets, whose payload is intentionally not imported (only their description is).
725
+ */
733
726
  skipped_files?: Array<string>;
734
727
  };
735
728
  export type ImportAssets_AssetIds = {
@@ -790,8 +783,10 @@ export type GetSessionsInFolder_Session = {
790
783
  folder_id: string;
791
784
  /** Maximum number of users allowed in this session at the same time */
792
785
  max_users: number;
793
- /** User identifier of the creator of the session */
786
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
794
787
  creator_user_id: string;
788
+ /** User identifier of the creator of the session */
789
+ created_by?: GetSessionsInFolder_CreatedBy;
795
790
  /** Session creation date */
796
791
  created_at: string;
797
792
  /** Country code of the rendering server location */
@@ -803,6 +798,12 @@ export type GetSessionsInFolder_Session = {
803
798
  /** Current clients in session */
804
799
  clients: Array<GetSessionsInFolder_Client_UserInfo>;
805
800
  };
801
+ export type GetSessionsInFolder_CreatedBy = {
802
+ /** User unique identifier */
803
+ user_id?: string;
804
+ username?: string;
805
+ required?: any;
806
+ };
806
807
  export type GetSessionsInFolder_Client_UserInfo = {
807
808
  /** Client unique identifier */
808
809
  client_id?: string;
@@ -849,6 +850,34 @@ export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
849
850
  */
850
851
  delete_assets?: boolean;
851
852
  }, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
853
+ export type GetSupportedSourceFileFormats_SupportedSourceFileFormats = {
854
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
855
+ cubemap: GetSupportedSourceFileFormats_SupportedFormat;
856
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
857
+ point_cloud: GetSupportedSourceFileFormats_SupportedFormat;
858
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
859
+ scene: GetSupportedSourceFileFormats_SupportedFormat;
860
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
861
+ sound: GetSupportedSourceFileFormats_SupportedFormat;
862
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
863
+ texture: GetSupportedSourceFileFormats_SupportedFormat;
864
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
865
+ volume: GetSupportedSourceFileFormats_SupportedFormat;
866
+ };
867
+ export type GetSupportedSourceFileFormats_SupportedFormat = {
868
+ /** Extra file extensions to bundle with a given primary extension. */
869
+ associated_file_extensions?: GetSupportedSourceFileFormats_Object;
870
+ /** Per sub-pipeline breakdown, keyed by converter name. */
871
+ converters: GetSupportedSourceFileFormats_Object;
872
+ file_extensions: Array<string>;
873
+ };
874
+ export type GetSupportedSourceFileFormats_Object = {
875
+ [_additionalproperties_: string]: Array<string>;
876
+ };
877
+ /**
878
+ * Returns the source file formats accepted for conversion, grouped by conversion type, with the per-converter breakdown and each converter's options schema.
879
+ */
880
+ export declare function getSupportedSourceFileFormats(headers?: AxiosRequestHeaders): AxiosPromise<GetSupportedSourceFileFormats_SupportedSourceFileFormats>;
852
881
  /**
853
882
  * Downloads the target source file.
854
883
  */
@@ -1476,7 +1505,7 @@ export type GetAssetDescription_Aabb = {
1476
1505
  };
1477
1506
  export type GetAssetDescription_RenderGraph = {
1478
1507
  /** All blend states */
1479
- blendStateDescriptions?: Array<GetAssetDescription_Object>;
1508
+ blendStateDescriptions?: Array<GetAssetDescription_BlendState>;
1480
1509
  /** Descriptions of all buffers */
1481
1510
  bufferDescriptions?: Array<GetAssetDescription_Object>;
1482
1511
  /** Conditions referenced by conditionIndex */
@@ -1490,7 +1519,7 @@ export type GetAssetDescription_RenderGraph = {
1490
1519
  /** Name of the asset */
1491
1520
  name: string;
1492
1521
  /** Descriptions of all nodes */
1493
- 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>;
1522
+ 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>;
1494
1523
  /** The index of the render target used for occlusion */
1495
1524
  occlusionInputDepthRenderTargetIndex?: number;
1496
1525
  /** Descriptions of all render passes */
@@ -1504,6 +1533,24 @@ export type GetAssetDescription_RenderGraph = {
1504
1533
  /** Unique identifier for the asset */
1505
1534
  uuid: string;
1506
1535
  };
1536
+ export type GetAssetDescription_BlendState = {
1537
+ /** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
1538
+ alphaBlendOp?: number;
1539
+ /** 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. */
1540
+ blendEnable?: boolean;
1541
+ /** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
1542
+ colorBlendOp?: number;
1543
+ /** 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. */
1544
+ colorWriteMask?: number;
1545
+ /** Selects which blend factor is used to determine the destination factor Da. */
1546
+ dstAlphaBlendFactor?: number;
1547
+ /** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
1548
+ dstColorBlendFactor?: number;
1549
+ /** Selects which blend factor is used to determine the source factor Sa. */
1550
+ srcAlphaBlendFactor?: number;
1551
+ /** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
1552
+ srcColorBlendFactor?: number;
1553
+ };
1507
1554
  export type GetAssetDescription_Viewport = {
1508
1555
  type?: 0;
1509
1556
  };
@@ -1543,6 +1590,7 @@ export type GetAssetDescription_DispatchCompute = {
1543
1590
  type?: 3;
1544
1591
  };
1545
1592
  export type GetAssetDescription_BlitImage = {
1593
+ filter?: number;
1546
1594
  /** Source render target */
1547
1595
  inputRenderTargetIndices?: Array<number>;
1548
1596
  /** Destination render target */
@@ -1583,9 +1631,12 @@ export type GetAssetDescription_DrawFullscreen = {
1583
1631
  shaderRef?: string;
1584
1632
  type?: 8;
1585
1633
  };
1586
- export type GetAssetDescription_GenerateMipChain = {
1634
+ export type GetAssetDescription_BlitMipChain = {
1635
+ filter?: number;
1587
1636
  /** Source render target */
1588
1637
  inputRenderTargetIndices?: Array<number>;
1638
+ /** Mip generation mode */
1639
+ mode?: StrictUnion<0 | 1> & number;
1589
1640
  type?: 9;
1590
1641
  };
1591
1642
  export type GetAssetDescription_CopyToCubemapFace = {
@@ -1593,6 +1644,19 @@ export type GetAssetDescription_CopyToCubemapFace = {
1593
1644
  inputRenderTargetIndices?: Array<number>;
1594
1645
  type?: 10;
1595
1646
  };
1647
+ export type GetAssetDescription_DispatchMipChain = {
1648
+ /** Specialization constants values for the specified shader */
1649
+ constantsJson?: object;
1650
+ /** Data provided to the shader through the node data buffer */
1651
+ dataJson?: object;
1652
+ /** Source render target */
1653
+ inputRenderTargetIndices?: Array<number>;
1654
+ /** Mip generation mode */
1655
+ mode?: StrictUnion<0 | 1> & number;
1656
+ /** Unique identifier for the asset */
1657
+ shaderRef?: string;
1658
+ type?: 11;
1659
+ };
1596
1660
  export type GetAssetDescription_ClearImages = {
1597
1661
  /** Clear colors */
1598
1662
  clearColors?: Array<Array<number>>;
@@ -1653,7 +1717,7 @@ export type GetAssetDescription_ParameterDescriptor = {
1653
1717
  /** Categories */
1654
1718
  categories?: Array<string>;
1655
1719
  /** Parameter default value */
1656
- default?: StrictUnion<number | boolean | Array<number>>;
1720
+ default?: number | boolean | Array<number>;
1657
1721
  /** 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) */
1658
1722
  isReferenceResource?: boolean;
1659
1723
  /** Parameter name */
@@ -1662,8 +1726,10 @@ export type GetAssetDescription_ParameterDescriptor = {
1662
1726
  nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
1663
1727
  /** Parameter offset in bytes */
1664
1728
  offset: number;
1729
+ /** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
1730
+ properties?: GetAssetDescription_ParameterProperties;
1665
1731
  /** Parameter type */
1666
- type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
1732
+ type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
1667
1733
  };
1668
1734
  export type GetAssetDescription_BufferProperties = {
1669
1735
  /** 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 +1739,14 @@ export type GetAssetDescription_BufferProperties = {
1673
1739
  /** How this buffer is going to be used */
1674
1740
  usage: number;
1675
1741
  };
1742
+ export type GetAssetDescription_ParameterProperties = {
1743
+ /** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
1744
+ format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
1745
+ /** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
1746
+ openMode?: 'read' | 'write' | 'readwrite';
1747
+ /** 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) */
1748
+ spec?: GetAssetDescription_Object;
1749
+ };
1676
1750
  export type GetAssetDescription_Scene = {
1677
1751
  /** Bounding box in local space */
1678
1752
  aabb: GetAssetDescription_Aabb;
@@ -1706,6 +1780,8 @@ export type GetAssetDescription_Shader = {
1706
1780
  computeSettings?: GetAssetDescription_ComputeShaderSettings;
1707
1781
  /** Data descriptor for specialization constants */
1708
1782
  constantDescriptor?: Array<GetAssetDescription_SpecializationConstantDescriptor>;
1783
+ /** GLSL extensions required by this shader, detected from the SPIR-V capabilities declared by its compiled modules */
1784
+ glslExtensions?: Array<GetAssetDescription_GlslExtension>;
1709
1785
  /** Data descriptor for material shaders */
1710
1786
  materialDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
1711
1787
  /** Descriptions of all modules that compose this shader */
@@ -1718,6 +1794,8 @@ export type GetAssetDescription_Shader = {
1718
1794
  nodeDataDescriptorHash?: number;
1719
1795
  /** The size in byte of the compiled shader code (accumulated size of all modules) */
1720
1796
  payloadSize?: number;
1797
+ /** Reference to the shader context associated with this shader. Only present for shaders that use one. */
1798
+ shaderContextRef?: string;
1721
1799
  /** Vulkan bit mask of all shader stages present in this shader */
1722
1800
  shaderStages?: number;
1723
1801
  /** Unique identifier for the asset */
@@ -1727,7 +1805,7 @@ export type GetAssetDescription_Shader = {
1727
1805
  };
1728
1806
  export type GetAssetDescription_ComputeShaderSettings = {
1729
1807
  /** Global group reference */
1730
- sizeReference?: StrictUnion<0 | 1 | 2>;
1808
+ sizeReference?: StrictUnion<0 | 1 | 2 | 3>;
1731
1809
  /** Size of the workgroup */
1732
1810
  workgroupSize?: Array<number>;
1733
1811
  /** Scaling factor to apply to the total workgroup count */
@@ -1735,7 +1813,7 @@ export type GetAssetDescription_ComputeShaderSettings = {
1735
1813
  };
1736
1814
  export type GetAssetDescription_SpecializationConstantDescriptor = {
1737
1815
  /** Constant default value */
1738
- default: StrictUnion<number | boolean>;
1816
+ default: number | boolean;
1739
1817
  /** Description */
1740
1818
  description?: string;
1741
1819
  /** Display name */
@@ -1745,6 +1823,12 @@ export type GetAssetDescription_SpecializationConstantDescriptor = {
1745
1823
  /** Constant type */
1746
1824
  type: 'bool' | 'int' | 'uint' | 'float';
1747
1825
  };
1826
+ export type GetAssetDescription_GlslExtension = {
1827
+ /** SPIR-V capability id that requires this extension (e.g. 5347 for PhysicalStorageBufferAddresses) */
1828
+ capabilityId: number;
1829
+ /** GLSL extension name, e.g. "GL_EXT_buffer_reference" */
1830
+ name: string;
1831
+ };
1748
1832
  export type GetAssetDescription_ShaderModuleDescription = {
1749
1833
  /** Names of the bindings used by this module */
1750
1834
  bindings?: Array<string>;
@@ -1796,13 +1880,25 @@ export type GetAssetDescription_VertexAttributeDescriptor = {
1796
1880
  stride: number;
1797
1881
  };
1798
1882
  export type GetAssetDescription_ShaderContext = {
1799
- /** Data descriptor for this shader context */
1883
+ /** The fields every shader in this family reads as input */
1800
1884
  dataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
1801
1885
  /** Name of the asset */
1802
1886
  name: string;
1887
+ /** The fields a material shader must produce. */
1888
+ outputDescriptor?: Array<GetAssetDescription_OutputFieldDescriptor>;
1803
1889
  /** Unique identifier for the asset */
1804
1890
  uuid: string;
1805
1891
  };
1892
+ export type GetAssetDescription_OutputFieldDescriptor = {
1893
+ /** Blend state of the attachment, no blending if absent */
1894
+ blendState?: GetAssetDescription_BlendState;
1895
+ /** What this field represents */
1896
+ description: string;
1897
+ /** Field name */
1898
+ name: string;
1899
+ /** Field data type */
1900
+ type: 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4';
1901
+ };
1806
1902
  export type GetAssetDescription_Skeleton = {
1807
1903
  /** Descriptions of all bones forming the skeleton */
1808
1904
  bones: Array<GetAssetDescription_Object>;
@@ -1912,7 +2008,7 @@ export type UpdateAssetDescription_Material = {
1912
2008
  };
1913
2009
  export type UpdateAssetDescription_RenderGraph = {
1914
2010
  /** All blend states */
1915
- blendStateDescriptions?: Array<UpdateAssetDescription_Object>;
2011
+ blendStateDescriptions?: Array<UpdateAssetDescription_BlendState>;
1916
2012
  /** Descriptions of all buffers */
1917
2013
  bufferDescriptions?: Array<UpdateAssetDescription_Object>;
1918
2014
  /** Conditions referenced by conditionIndex */
@@ -1926,7 +2022,7 @@ export type UpdateAssetDescription_RenderGraph = {
1926
2022
  /** Name of the asset */
1927
2023
  name: string;
1928
2024
  /** Descriptions of all nodes */
1929
- 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>;
2025
+ 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>;
1930
2026
  /** The index of the render target used for occlusion */
1931
2027
  occlusionInputDepthRenderTargetIndex?: number;
1932
2028
  /** Descriptions of all render passes */
@@ -1938,24 +2034,34 @@ export type UpdateAssetDescription_RenderGraph = {
1938
2034
  /** All stencil states */
1939
2035
  stencilOpStateDescriptions?: Array<UpdateAssetDescription_Object>;
1940
2036
  };
1941
- export type UpdateAssetDescription_Object = {
1942
- /** Alpha blend operator */
2037
+ export type UpdateAssetDescription_BlendState = {
2038
+ /** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
1943
2039
  alphaBlendOp?: number;
1944
- /** Enable blending */
2040
+ /** 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. */
1945
2041
  blendEnable?: boolean;
1946
- /** Color blend operator */
2042
+ /** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
1947
2043
  colorBlendOp?: number;
1948
- /** Color write mask */
2044
+ /** 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. */
1949
2045
  colorWriteMask?: number;
1950
- /** Destination alpha blend factor */
2046
+ /** Selects which blend factor is used to determine the destination factor Da. */
1951
2047
  dstAlphaBlendFactor?: number;
1952
- /** Destination color blend factor */
2048
+ /** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
1953
2049
  dstColorBlendFactor?: number;
1954
- /** Source alpha blend factor */
2050
+ /** Selects which blend factor is used to determine the source factor Sa. */
1955
2051
  srcAlphaBlendFactor?: number;
1956
- /** Source color blend factor */
2052
+ /** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
1957
2053
  srcColorBlendFactor?: number;
1958
2054
  };
2055
+ export type UpdateAssetDescription_Object = {
2056
+ /** 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 */
2057
+ elementCount?: StrictUnion<number | Array<number>>;
2058
+ /** Size in bytes of a single element in the buffer */
2059
+ elementSize?: number;
2060
+ /** Buffer name */
2061
+ name?: string;
2062
+ /** How this buffer is going to be used */
2063
+ usage?: number;
2064
+ };
1959
2065
  export type UpdateAssetDescription_Viewport = {
1960
2066
  type?: 0;
1961
2067
  };
@@ -1991,6 +2097,7 @@ export type UpdateAssetDescription_DispatchCompute = {
1991
2097
  type?: 3;
1992
2098
  };
1993
2099
  export type UpdateAssetDescription_BlitImage = {
2100
+ filter?: number;
1994
2101
  /** Source render target */
1995
2102
  inputRenderTargetIndices?: Array<number>;
1996
2103
  /** Destination render target */
@@ -2027,9 +2134,12 @@ export type UpdateAssetDescription_DrawFullscreen = {
2027
2134
  pipelineDescription?: UpdateAssetDescription_Object;
2028
2135
  type?: 8;
2029
2136
  };
2030
- export type UpdateAssetDescription_GenerateMipChain = {
2137
+ export type UpdateAssetDescription_BlitMipChain = {
2138
+ filter?: number;
2031
2139
  /** Source render target */
2032
2140
  inputRenderTargetIndices?: Array<number>;
2141
+ /** Mip generation mode */
2142
+ mode?: StrictUnion<0 | 1> & number;
2033
2143
  type?: 9;
2034
2144
  };
2035
2145
  export type UpdateAssetDescription_CopyToCubemapFace = {
@@ -2037,6 +2147,17 @@ export type UpdateAssetDescription_CopyToCubemapFace = {
2037
2147
  inputRenderTargetIndices?: Array<number>;
2038
2148
  type?: 10;
2039
2149
  };
2150
+ export type UpdateAssetDescription_DispatchMipChain = {
2151
+ /** Specialization constants values for the specified shader */
2152
+ constantsJson?: object;
2153
+ /** Data provided to the shader through the node data buffer */
2154
+ dataJson?: object;
2155
+ /** Source render target */
2156
+ inputRenderTargetIndices?: Array<number>;
2157
+ /** Mip generation mode */
2158
+ mode?: StrictUnion<0 | 1> & number;
2159
+ type?: 11;
2160
+ };
2040
2161
  export type UpdateAssetDescription_ClearImages = {
2041
2162
  /** Clear colors */
2042
2163
  clearColors?: Array<Array<number>>;
@@ -2093,7 +2214,7 @@ export type UpdateAssetDescription_ParameterDescriptor = {
2093
2214
  /** Categories */
2094
2215
  categories?: Array<string>;
2095
2216
  /** Parameter default value */
2096
- default?: StrictUnion<number | boolean | Array<number>>;
2217
+ default?: number | boolean | Array<number>;
2097
2218
  /** 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) */
2098
2219
  isReferenceResource?: boolean;
2099
2220
  /** Parameter name */
@@ -2102,8 +2223,10 @@ export type UpdateAssetDescription_ParameterDescriptor = {
2102
2223
  nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
2103
2224
  /** Parameter offset in bytes */
2104
2225
  offset: number;
2226
+ /** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
2227
+ properties?: UpdateAssetDescription_ParameterProperties;
2105
2228
  /** Parameter type */
2106
- type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
2229
+ type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
2107
2230
  };
2108
2231
  export type UpdateAssetDescription_BufferProperties = {
2109
2232
  /** 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 +2236,14 @@ export type UpdateAssetDescription_BufferProperties = {
2113
2236
  /** How this buffer is going to be used */
2114
2237
  usage: number;
2115
2238
  };
2239
+ export type UpdateAssetDescription_ParameterProperties = {
2240
+ /** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
2241
+ format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
2242
+ /** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
2243
+ openMode?: 'read' | 'write' | 'readwrite';
2244
+ /** 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) */
2245
+ spec?: UpdateAssetDescription_Object;
2246
+ };
2116
2247
  /**
2117
2248
  * Updates the description of the specified asset.
2118
2249
  */
@@ -2230,8 +2361,10 @@ export type GetSceneSessions_Session = {
2230
2361
  folder_id: string;
2231
2362
  /** Maximum number of users allowed in this session at the same time */
2232
2363
  max_users: number;
2233
- /** User identifier of the creator of the session */
2364
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
2234
2365
  creator_user_id: string;
2366
+ /** User identifier of the creator of the session */
2367
+ created_by?: GetSceneSessions_CreatedBy;
2235
2368
  /** Session creation date */
2236
2369
  created_at: string;
2237
2370
  /** Country code of the rendering server location */
@@ -2243,6 +2376,12 @@ export type GetSceneSessions_Session = {
2243
2376
  /** Current clients in session */
2244
2377
  clients: Array<GetSceneSessions_Client_UserInfo>;
2245
2378
  };
2379
+ export type GetSceneSessions_CreatedBy = {
2380
+ /** User unique identifier */
2381
+ user_id?: string;
2382
+ username?: string;
2383
+ required?: any;
2384
+ };
2246
2385
  export type GetSceneSessions_Client_UserInfo = {
2247
2386
  /** Client unique identifier */
2248
2387
  client_id?: string;
@@ -4098,8 +4237,10 @@ export type GetRunningSessions_Session = {
4098
4237
  folder_id: string;
4099
4238
  /** Maximum number of users allowed in this session at the same time */
4100
4239
  max_users: number;
4101
- /** User identifier of the creator of the session */
4240
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
4102
4241
  creator_user_id: string;
4242
+ /** User identifier of the creator of the session */
4243
+ created_by?: GetRunningSessions_CreatedBy;
4103
4244
  /** Session creation date */
4104
4245
  created_at: string;
4105
4246
  /** Country code of the rendering server location */
@@ -4111,6 +4252,12 @@ export type GetRunningSessions_Session = {
4111
4252
  /** Current clients in session */
4112
4253
  clients: Array<GetRunningSessions_Client_UserInfo>;
4113
4254
  };
4255
+ export type GetRunningSessions_CreatedBy = {
4256
+ /** User unique identifier */
4257
+ user_id?: string;
4258
+ username?: string;
4259
+ required?: any;
4260
+ };
4114
4261
  export type GetRunningSessions_Client_UserInfo = {
4115
4262
  /** Client unique identifier */
4116
4263
  client_id?: string;
@@ -4154,8 +4301,10 @@ export type GetSession_Session = {
4154
4301
  folder_id: string;
4155
4302
  /** Maximum number of users allowed in this session at the same time */
4156
4303
  max_users: number;
4157
- /** User identifier of the creator of the session */
4304
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
4158
4305
  creator_user_id: string;
4306
+ /** User identifier of the creator of the session */
4307
+ created_by?: GetSession_CreatedBy;
4159
4308
  /** Session creation date */
4160
4309
  created_at: string;
4161
4310
  /** Country code of the rendering server location */
@@ -4167,6 +4316,12 @@ export type GetSession_Session = {
4167
4316
  /** Current clients in session */
4168
4317
  clients: Array<GetSession_Client_UserInfo>;
4169
4318
  };
4319
+ export type GetSession_CreatedBy = {
4320
+ /** User unique identifier */
4321
+ user_id?: string;
4322
+ username?: string;
4323
+ required?: any;
4324
+ };
4170
4325
  export type GetSession_Client_UserInfo = {
4171
4326
  /** Client unique identifier */
4172
4327
  client_id?: string;
package/dist/index.js CHANGED
@@ -81,6 +81,7 @@ __export(index_exports, {
81
81
  getSourceFileAssets: () => getSourceFileAssets,
82
82
  getSourceFileDetails: () => getSourceFileDetails,
83
83
  getSourceFilesInFolder: () => getSourceFilesInFolder,
84
+ getSupportedSourceFileFormats: () => getSupportedSourceFileFormats,
84
85
  getUploadTask: () => getUploadTask,
85
86
  getUploadTasks: () => getUploadTasks,
86
87
  getUploadTasksInFolder: () => getUploadTasksInFolder,
@@ -646,6 +647,13 @@ function deleteSourceFiles({
646
647
  headers
647
648
  });
648
649
  }
650
+ function getSupportedSourceFileFormats(headers) {
651
+ return axiosInstance({
652
+ method: "get",
653
+ url: "/source-files/supported-formats",
654
+ headers
655
+ });
656
+ }
649
657
  function downloadSourceFile({
650
658
  source_file_id
651
659
  }, headers, responseType) {
@@ -1348,6 +1356,7 @@ installInterceptors();
1348
1356
  getSourceFileAssets,
1349
1357
  getSourceFileDetails,
1350
1358
  getSourceFilesInFolder,
1359
+ getSupportedSourceFileFormats,
1351
1360
  getUploadTask,
1352
1361
  getUploadTasks,
1353
1362
  getUploadTasksInFolder,