@3dverse/api 0.8.19 → 0.8.21
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.
- package/dist/_prebuild/wrapper.d.ts +385 -65
- package/dist/index.js.map +2 -2
- package/dist/index.mjs.map +2 -2
- package/package.json +1 -1
|
@@ -94,7 +94,32 @@ export declare function updateUser({ user_id, username, }: {
|
|
|
94
94
|
username: string;
|
|
95
95
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
96
96
|
export type DeleteUser_Object = {
|
|
97
|
-
deleted_assets?:
|
|
97
|
+
deleted_assets?: DeleteUser_AssetList;
|
|
98
|
+
};
|
|
99
|
+
export type DeleteUser_AssetList = {
|
|
100
|
+
action_maps?: Array<DeleteUser_Object>;
|
|
101
|
+
animation_graphs?: Array<DeleteUser_Object>;
|
|
102
|
+
animation_sequences?: Array<DeleteUser_Object>;
|
|
103
|
+
animation_sets?: Array<DeleteUser_Object>;
|
|
104
|
+
animations?: Array<DeleteUser_Object>;
|
|
105
|
+
collision_geometries?: Array<DeleteUser_Object>;
|
|
106
|
+
cubemaps?: Array<DeleteUser_Object>;
|
|
107
|
+
event_maps?: Array<DeleteUser_Object>;
|
|
108
|
+
materials?: Array<DeleteUser_Object>;
|
|
109
|
+
meshes?: Array<DeleteUser_Object>;
|
|
110
|
+
modules?: Array<DeleteUser_Object>;
|
|
111
|
+
point_clouds?: Array<DeleteUser_Object>;
|
|
112
|
+
render_graphs?: Array<DeleteUser_Object>;
|
|
113
|
+
scenes?: Array<DeleteUser_Object>;
|
|
114
|
+
scripts?: Array<DeleteUser_Object>;
|
|
115
|
+
shader_contexts?: Array<DeleteUser_Object>;
|
|
116
|
+
shaders?: Array<DeleteUser_Object>;
|
|
117
|
+
skeletons?: Array<DeleteUser_Object>;
|
|
118
|
+
sounds?: Array<DeleteUser_Object>;
|
|
119
|
+
textures?: Array<DeleteUser_Object>;
|
|
120
|
+
textures_1d?: Array<DeleteUser_Object>;
|
|
121
|
+
textures_3d?: Array<DeleteUser_Object>;
|
|
122
|
+
volume_materials?: Array<DeleteUser_Object>;
|
|
98
123
|
};
|
|
99
124
|
/**
|
|
100
125
|
* Deletes the target user.
|
|
@@ -573,9 +598,11 @@ export type GetFolderAssets_Filters = {
|
|
|
573
598
|
/** Look for assets containing the given name (case-insensitive) */
|
|
574
599
|
asset_name?: string;
|
|
575
600
|
/** @deprecated Deprecated. Use asset_types instead. Look for assets of the given type */
|
|
576
|
-
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
601
|
+
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
577
602
|
/** Look for assets of the given types */
|
|
578
|
-
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
603
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
604
|
+
/** Look for assets associated with or without libraries */
|
|
605
|
+
library?: Array<string> | string | 'exclude';
|
|
579
606
|
/** Look for assets associated with or without source files */
|
|
580
607
|
source_file?: Array<string> | string | 'exclude';
|
|
581
608
|
};
|
|
@@ -585,7 +612,7 @@ export type GetFolderAssets_AssetCount = {
|
|
|
585
612
|
/** Total number of assets in target folder of specific type. */
|
|
586
613
|
[asset_type: string]: number;
|
|
587
614
|
};
|
|
588
|
-
export type
|
|
615
|
+
export type GetFolderAssets_AssetList = {
|
|
589
616
|
action_maps?: Array<GetFolderAssets_Object>;
|
|
590
617
|
animation_graphs?: Array<GetFolderAssets_Object>;
|
|
591
618
|
animation_sequences?: Array<GetFolderAssets_Object>;
|
|
@@ -601,6 +628,7 @@ export type GetFolderAssets__index_AssetList_AssetList = {
|
|
|
601
628
|
render_graphs?: Array<GetFolderAssets_Object>;
|
|
602
629
|
scenes?: Array<GetFolderAssets_Object>;
|
|
603
630
|
scripts?: Array<GetFolderAssets_Object>;
|
|
631
|
+
shader_contexts?: Array<GetFolderAssets_Object>;
|
|
604
632
|
shaders?: Array<GetFolderAssets_Object>;
|
|
605
633
|
skeletons?: Array<GetFolderAssets_Object>;
|
|
606
634
|
sounds?: Array<GetFolderAssets_Object>;
|
|
@@ -623,13 +651,13 @@ export declare function getFolderAssets({ folder_id, offset, limit, filter, recu
|
|
|
623
651
|
limit?: number;
|
|
624
652
|
filter?: GetFolderAssets_Filters;
|
|
625
653
|
recursive?: boolean;
|
|
626
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
654
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<GetFolderAssets_AssetList>;
|
|
627
655
|
export type CreateAsset_NewAsset = {
|
|
628
656
|
asset_type: 'action_map' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
|
|
629
657
|
name: string;
|
|
630
658
|
};
|
|
631
659
|
export type CreateAsset_AssetDuplication = {
|
|
632
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
660
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
633
661
|
/** Asset unique identifier */
|
|
634
662
|
copy_from_asset_id: string;
|
|
635
663
|
new_asset_name?: string;
|
|
@@ -638,7 +666,7 @@ export type CreateAsset_AssetDuplication = {
|
|
|
638
666
|
};
|
|
639
667
|
export type CreateAsset_DuplicationOptions = {
|
|
640
668
|
/** Limits the duplication to the specified asset types */
|
|
641
|
-
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
669
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
642
670
|
/** Limits the depth level of the duplication process. */
|
|
643
671
|
max_depth?: number;
|
|
644
672
|
};
|
|
@@ -851,7 +879,7 @@ export declare function updateSourceFileDetails({ source_file_id, name, }: {
|
|
|
851
879
|
/** Source file display name */
|
|
852
880
|
name: string;
|
|
853
881
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
854
|
-
export type
|
|
882
|
+
export type GetSourceFileAssets_AssetList = {
|
|
855
883
|
action_maps?: Array<GetSourceFileAssets_Object>;
|
|
856
884
|
animation_graphs?: Array<GetSourceFileAssets_Object>;
|
|
857
885
|
animation_sequences?: Array<GetSourceFileAssets_Object>;
|
|
@@ -867,6 +895,7 @@ export type GetSourceFileAssets__index_AssetList_AssetList = {
|
|
|
867
895
|
render_graphs?: Array<GetSourceFileAssets_Object>;
|
|
868
896
|
scenes?: Array<GetSourceFileAssets_Object>;
|
|
869
897
|
scripts?: Array<GetSourceFileAssets_Object>;
|
|
898
|
+
shader_contexts?: Array<GetSourceFileAssets_Object>;
|
|
870
899
|
shaders?: Array<GetSourceFileAssets_Object>;
|
|
871
900
|
skeletons?: Array<GetSourceFileAssets_Object>;
|
|
872
901
|
sounds?: Array<GetSourceFileAssets_Object>;
|
|
@@ -885,7 +914,7 @@ export type GetSourceFileAssets_Object = {
|
|
|
885
914
|
*/
|
|
886
915
|
export declare function getSourceFileAssets({ source_file_id, }: {
|
|
887
916
|
source_file_id: string;
|
|
888
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
917
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<GetSourceFileAssets_AssetList>;
|
|
889
918
|
/**
|
|
890
919
|
* Lists all upload tasks. These upload tasks relate to uploaded source files.
|
|
891
920
|
*/
|
|
@@ -942,7 +971,7 @@ export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'str
|
|
|
942
971
|
filename: string;
|
|
943
972
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
944
973
|
export type SchedulePipeline_Object = {
|
|
945
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
974
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
946
975
|
/** Asset unique identifier */
|
|
947
976
|
asset_id: string;
|
|
948
977
|
};
|
|
@@ -1030,15 +1059,15 @@ export declare function getPipeline({ pipeline_id, }: {
|
|
|
1030
1059
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetPipeline_Pipeline>;
|
|
1031
1060
|
export type ListAssets_Filter = {
|
|
1032
1061
|
/** @deprecated Deprecated. Use asset_types instead. Look for assets of the given type */
|
|
1033
|
-
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
1062
|
+
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
1034
1063
|
/** Look for assets of the given types */
|
|
1035
|
-
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1064
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1036
1065
|
/** Filter by asset name */
|
|
1037
1066
|
asset_name?: string;
|
|
1038
1067
|
/** Include assets coming from public libraries */
|
|
1039
1068
|
include_public_assets?: boolean;
|
|
1040
1069
|
};
|
|
1041
|
-
export type
|
|
1070
|
+
export type ListAssets_AssetList = {
|
|
1042
1071
|
action_maps?: Array<ListAssets_Object>;
|
|
1043
1072
|
animation_graphs?: Array<ListAssets_Object>;
|
|
1044
1073
|
animation_sequences?: Array<ListAssets_Object>;
|
|
@@ -1054,6 +1083,7 @@ export type ListAssets__index_AssetList_AssetList = {
|
|
|
1054
1083
|
render_graphs?: Array<ListAssets_Object>;
|
|
1055
1084
|
scenes?: Array<ListAssets_Object>;
|
|
1056
1085
|
scripts?: Array<ListAssets_Object>;
|
|
1086
|
+
shader_contexts?: Array<ListAssets_Object>;
|
|
1057
1087
|
shaders?: Array<ListAssets_Object>;
|
|
1058
1088
|
skeletons?: Array<ListAssets_Object>;
|
|
1059
1089
|
sounds?: Array<ListAssets_Object>;
|
|
@@ -1074,7 +1104,7 @@ export declare function listAssets({ offset, limit, filter, }: {
|
|
|
1074
1104
|
offset?: number;
|
|
1075
1105
|
limit?: number;
|
|
1076
1106
|
filter?: ListAssets_Filter;
|
|
1077
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
1107
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<ListAssets_AssetList>;
|
|
1078
1108
|
/**
|
|
1079
1109
|
* Batch delete assets. You **MUST NOT** reference assets.
|
|
1080
1110
|
*/
|
|
@@ -1085,7 +1115,7 @@ export declare function deleteAssets({ asset_ids, }: {
|
|
|
1085
1115
|
* Deletes the asset.
|
|
1086
1116
|
*/
|
|
1087
1117
|
export declare function deleteAsset({ asset_container, asset_id, }: {
|
|
1088
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1118
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1089
1119
|
asset_id: string;
|
|
1090
1120
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
1091
1121
|
export type GetAssetSourceFile_SourceFile = {
|
|
@@ -1102,7 +1132,7 @@ export type GetAssetSourceFile_SourceFile = {
|
|
|
1102
1132
|
* Gets the source file of the specified asset.
|
|
1103
1133
|
*/
|
|
1104
1134
|
export declare function getAssetSourceFile({ asset_container, asset_id, }: {
|
|
1105
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1135
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1106
1136
|
asset_id: string;
|
|
1107
1137
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetSourceFile_SourceFile>;
|
|
1108
1138
|
export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
|
@@ -1121,7 +1151,7 @@ The user object lets you create or update user tokens that identify the useron t
|
|
|
1121
1151
|
*/
|
|
1122
1152
|
last_edited_by?: GetAssetDetails_LastEditedBy;
|
|
1123
1153
|
name: string;
|
|
1124
|
-
type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1154
|
+
type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1125
1155
|
};
|
|
1126
1156
|
export type GetAssetDetails_Contributor = {
|
|
1127
1157
|
contribution_count: number;
|
|
@@ -1151,7 +1181,7 @@ export type GetAssetDetails_LastEditedBy = {
|
|
|
1151
1181
|
* Gets the asset details from the specified asset.
|
|
1152
1182
|
*/
|
|
1153
1183
|
export declare function getAssetDetails({ asset_container, asset_id, }: {
|
|
1154
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1184
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1155
1185
|
asset_id: string;
|
|
1156
1186
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
|
|
1157
1187
|
export type GetAssetFolder_Folder = {
|
|
@@ -1179,21 +1209,21 @@ export type GetAssetFolder_Object = {
|
|
|
1179
1209
|
* Gets the asset folder from the specified asset.
|
|
1180
1210
|
*/
|
|
1181
1211
|
export declare function getAssetFolder({ asset_container, asset_id, }: {
|
|
1182
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1212
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1183
1213
|
asset_id: string;
|
|
1184
1214
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetFolder_Folder>;
|
|
1185
1215
|
export type GetAssetDependencies_Filter = {
|
|
1186
1216
|
/** Filter dependencies by types */
|
|
1187
|
-
with_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1217
|
+
with_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1188
1218
|
/** Exclude dependencies by types */
|
|
1189
|
-
without_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1219
|
+
without_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1190
1220
|
/** Filter assets by public status */
|
|
1191
1221
|
public?: 'include' | 'exclude' | 'restrict-to';
|
|
1192
1222
|
};
|
|
1193
1223
|
export type GetAssetDependencies_Asset = {
|
|
1194
1224
|
/** Asset unique identifier */
|
|
1195
1225
|
asset_id: string;
|
|
1196
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1226
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1197
1227
|
/** Additional properties of the asset */
|
|
1198
1228
|
properties?: GetAssetDependencies_Object;
|
|
1199
1229
|
};
|
|
@@ -1228,7 +1258,7 @@ export type GetAssetDependencies_Dependency = {
|
|
|
1228
1258
|
* Gets the asset dependencies from the specified asset.
|
|
1229
1259
|
*/
|
|
1230
1260
|
export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties, }: {
|
|
1231
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1261
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1232
1262
|
asset_id: string;
|
|
1233
1263
|
offset?: number;
|
|
1234
1264
|
limit?: number;
|
|
@@ -1239,7 +1269,7 @@ export declare function getAssetDependencies({ asset_container, asset_id, offset
|
|
|
1239
1269
|
export type GetAssetReferences_Asset = {
|
|
1240
1270
|
/** Asset unique identifier */
|
|
1241
1271
|
asset_id: string;
|
|
1242
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1272
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1243
1273
|
/** Additional properties of the asset */
|
|
1244
1274
|
properties?: GetAssetReferences_Object;
|
|
1245
1275
|
};
|
|
@@ -1254,7 +1284,7 @@ export type GetAssetReferences_Object = {
|
|
|
1254
1284
|
* Gets the asset references from the specified asset.
|
|
1255
1285
|
*/
|
|
1256
1286
|
export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties, }: {
|
|
1257
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1287
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1258
1288
|
asset_id: string;
|
|
1259
1289
|
offset?: number;
|
|
1260
1290
|
limit?: number;
|
|
@@ -1419,11 +1449,11 @@ export type GetAssetDescription_PointCloud = {
|
|
|
1419
1449
|
bounds: GetAssetDescription_Aabb;
|
|
1420
1450
|
/** Description of the per-point attributes (position, color, etc.) */
|
|
1421
1451
|
channels: Array<GetAssetDescription_Channel>;
|
|
1422
|
-
/**
|
|
1423
|
-
|
|
1452
|
+
/** Size in bytes of each layer. A layer is a collection of nodes serialized into a single file. */
|
|
1453
|
+
layerSizes: Array<number>;
|
|
1424
1454
|
/** Name of the asset */
|
|
1425
1455
|
name: string;
|
|
1426
|
-
/** Number of nodes in the
|
|
1456
|
+
/** Number of nodes in the acceleration structure. */
|
|
1427
1457
|
nodeCount: number;
|
|
1428
1458
|
/** Number of points in the original point cloud before any spatial partitioning or filtering was applied */
|
|
1429
1459
|
originalPointCount: number;
|
|
@@ -1431,6 +1461,8 @@ export type GetAssetDescription_PointCloud = {
|
|
|
1431
1461
|
pageSize: number;
|
|
1432
1462
|
/** Total size in bytes of all attribute layer files. Sum of sizeof(payload.pointCloud.layer<N>-<attribute>.<uuid>) for all layers and attributes */
|
|
1433
1463
|
payloadTotalSize: number;
|
|
1464
|
+
/** Size in bytes of the acceleration structure at bake time. */
|
|
1465
|
+
pcasSize: number;
|
|
1434
1466
|
/** Total number of points across all nodes in the tree, including intermediary nodes. Greater than or equal to originalPointCount */
|
|
1435
1467
|
totalPointCount: number;
|
|
1436
1468
|
/** Unique identifier for the asset */
|
|
@@ -1444,7 +1476,9 @@ export type GetAssetDescription_Aabb = {
|
|
|
1444
1476
|
};
|
|
1445
1477
|
export type GetAssetDescription_RenderGraph = {
|
|
1446
1478
|
/** All blend states */
|
|
1447
|
-
blendStateDescriptions?: Array<
|
|
1479
|
+
blendStateDescriptions?: Array<GetAssetDescription_BlendState>;
|
|
1480
|
+
/** Descriptions of all buffers */
|
|
1481
|
+
bufferDescriptions?: Array<GetAssetDescription_Object>;
|
|
1448
1482
|
/** Conditions referenced by conditionIndex */
|
|
1449
1483
|
conditions?: Array<string>;
|
|
1450
1484
|
/** The index of the render target to blit into the canvas */
|
|
@@ -1456,24 +1490,46 @@ export type GetAssetDescription_RenderGraph = {
|
|
|
1456
1490
|
/** Name of the asset */
|
|
1457
1491
|
name: string;
|
|
1458
1492
|
/** Descriptions of all nodes */
|
|
1459
|
-
nodeDataDescriptions: Array<StrictUnion<GetAssetDescription_Viewport | GetAssetDescription_DrawBatch | GetAssetDescription_DrawBatchWithMaterials | GetAssetDescription_DispatchCompute | GetAssetDescription_BlitImage | GetAssetDescription_CopyImage | GetAssetDescription_ResolveImage | GetAssetDescription_DrawFullscreen |
|
|
1493
|
+
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>;
|
|
1460
1494
|
/** The index of the render target used for occlusion */
|
|
1461
1495
|
occlusionInputDepthRenderTargetIndex?: number;
|
|
1462
1496
|
/** Descriptions of all render passes */
|
|
1463
1497
|
renderPassDescriptions: Array<GetAssetDescription_Object>;
|
|
1464
1498
|
/** Descriptions of all render targets */
|
|
1465
1499
|
renderTargetDescriptions: Array<GetAssetDescription_Object>;
|
|
1500
|
+
/** Data descriptors for the shader contexts referenced by shaderContextIndex */
|
|
1501
|
+
shaderContexts?: Array<Array<GetAssetDescription_ParameterDescriptor>>;
|
|
1466
1502
|
/** All stencil states */
|
|
1467
1503
|
stencilOpStateDescriptions?: Array<GetAssetDescription_Object>;
|
|
1468
1504
|
/** Unique identifier for the asset */
|
|
1469
1505
|
uuid: string;
|
|
1470
1506
|
};
|
|
1507
|
+
export type GetAssetDescription_BlendState = {
|
|
1508
|
+
/** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
|
|
1509
|
+
alphaBlendOp?: number;
|
|
1510
|
+
/** 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. */
|
|
1511
|
+
blendEnable?: boolean;
|
|
1512
|
+
/** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
|
|
1513
|
+
colorBlendOp?: number;
|
|
1514
|
+
/** 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. */
|
|
1515
|
+
colorWriteMask?: number;
|
|
1516
|
+
/** Selects which blend factor is used to determine the destination factor Da. */
|
|
1517
|
+
dstAlphaBlendFactor?: number;
|
|
1518
|
+
/** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
|
|
1519
|
+
dstColorBlendFactor?: number;
|
|
1520
|
+
/** Selects which blend factor is used to determine the source factor Sa. */
|
|
1521
|
+
srcAlphaBlendFactor?: number;
|
|
1522
|
+
/** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
|
|
1523
|
+
srcColorBlendFactor?: number;
|
|
1524
|
+
};
|
|
1471
1525
|
export type GetAssetDescription_Viewport = {
|
|
1472
1526
|
type?: 0;
|
|
1473
1527
|
};
|
|
1474
1528
|
export type GetAssetDescription_DrawBatch = {
|
|
1475
|
-
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096 */
|
|
1529
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1476
1530
|
batchType?: number;
|
|
1531
|
+
/** Specialization constants values for the specified shader */
|
|
1532
|
+
constantsJson?: object;
|
|
1477
1533
|
/** Data provided to the shader through the node data buffer */
|
|
1478
1534
|
dataJson?: object;
|
|
1479
1535
|
/** Description of a shader pipeline */
|
|
@@ -1483,17 +1539,21 @@ export type GetAssetDescription_DrawBatch = {
|
|
|
1483
1539
|
type?: 1;
|
|
1484
1540
|
};
|
|
1485
1541
|
export type GetAssetDescription_DrawBatchWithMaterials = {
|
|
1486
|
-
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096 */
|
|
1542
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1487
1543
|
batchType?: number;
|
|
1488
1544
|
/** Data provided to the shader through the node data buffer */
|
|
1489
1545
|
dataJson?: object;
|
|
1490
1546
|
/** Description of a shader pipeline */
|
|
1491
1547
|
pipelineDescription?: GetAssetDescription_Object;
|
|
1548
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
1549
|
+
shaderContextIndex: number;
|
|
1492
1550
|
type?: 2;
|
|
1493
1551
|
};
|
|
1494
1552
|
export type GetAssetDescription_DispatchCompute = {
|
|
1495
1553
|
/** @deprecated Const data type */
|
|
1496
1554
|
constDataType?: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24> & number;
|
|
1555
|
+
/** Specialization constants values for the specified shader */
|
|
1556
|
+
constantsJson?: object;
|
|
1497
1557
|
/** Data provided to the shader through the node data buffer */
|
|
1498
1558
|
dataJson?: object;
|
|
1499
1559
|
/** Unique identifier for the asset */
|
|
@@ -1501,12 +1561,22 @@ export type GetAssetDescription_DispatchCompute = {
|
|
|
1501
1561
|
type?: 3;
|
|
1502
1562
|
};
|
|
1503
1563
|
export type GetAssetDescription_BlitImage = {
|
|
1564
|
+
filter?: number;
|
|
1504
1565
|
/** Source render target */
|
|
1505
1566
|
inputRenderTargetIndices?: Array<number>;
|
|
1506
1567
|
/** Destination render target */
|
|
1507
1568
|
outputRenderTargetIndices?: Array<number>;
|
|
1508
1569
|
type?: 4;
|
|
1509
1570
|
};
|
|
1571
|
+
export type GetAssetDescription_DispatchPointClouds = {
|
|
1572
|
+
/** Specialization constants values for the specified shader */
|
|
1573
|
+
constantsJson?: object;
|
|
1574
|
+
/** Data provided to the shader through the node data buffer */
|
|
1575
|
+
dataJson?: object;
|
|
1576
|
+
/** Unique identifier for the asset */
|
|
1577
|
+
shaderRef?: string;
|
|
1578
|
+
type?: 5;
|
|
1579
|
+
};
|
|
1510
1580
|
export type GetAssetDescription_CopyImage = {
|
|
1511
1581
|
/** Source render target */
|
|
1512
1582
|
inputRenderTargetIndices?: Array<number>;
|
|
@@ -1522,6 +1592,8 @@ export type GetAssetDescription_ResolveImage = {
|
|
|
1522
1592
|
type?: 7;
|
|
1523
1593
|
};
|
|
1524
1594
|
export type GetAssetDescription_DrawFullscreen = {
|
|
1595
|
+
/** Specialization constants values for the specified shader */
|
|
1596
|
+
constantsJson?: object;
|
|
1525
1597
|
/** Data provided to the shader through the node data buffer */
|
|
1526
1598
|
dataJson?: object;
|
|
1527
1599
|
/** Description of a shader pipeline */
|
|
@@ -1530,9 +1602,12 @@ export type GetAssetDescription_DrawFullscreen = {
|
|
|
1530
1602
|
shaderRef?: string;
|
|
1531
1603
|
type?: 8;
|
|
1532
1604
|
};
|
|
1533
|
-
export type
|
|
1605
|
+
export type GetAssetDescription_BlitMipChain = {
|
|
1606
|
+
filter?: number;
|
|
1534
1607
|
/** Source render target */
|
|
1535
1608
|
inputRenderTargetIndices?: Array<number>;
|
|
1609
|
+
/** Mip generation mode */
|
|
1610
|
+
mode?: StrictUnion<0 | 1> & number;
|
|
1536
1611
|
type?: 9;
|
|
1537
1612
|
};
|
|
1538
1613
|
export type GetAssetDescription_CopyToCubemapFace = {
|
|
@@ -1540,6 +1615,19 @@ export type GetAssetDescription_CopyToCubemapFace = {
|
|
|
1540
1615
|
inputRenderTargetIndices?: Array<number>;
|
|
1541
1616
|
type?: 10;
|
|
1542
1617
|
};
|
|
1618
|
+
export type GetAssetDescription_DispatchMipChain = {
|
|
1619
|
+
/** Specialization constants values for the specified shader */
|
|
1620
|
+
constantsJson?: object;
|
|
1621
|
+
/** Data provided to the shader through the node data buffer */
|
|
1622
|
+
dataJson?: object;
|
|
1623
|
+
/** Source render target */
|
|
1624
|
+
inputRenderTargetIndices?: Array<number>;
|
|
1625
|
+
/** Mip generation mode */
|
|
1626
|
+
mode?: StrictUnion<0 | 1> & number;
|
|
1627
|
+
/** Unique identifier for the asset */
|
|
1628
|
+
shaderRef?: string;
|
|
1629
|
+
type?: 11;
|
|
1630
|
+
};
|
|
1543
1631
|
export type GetAssetDescription_ClearImages = {
|
|
1544
1632
|
/** Clear colors */
|
|
1545
1633
|
clearColors?: Array<Array<number>>;
|
|
@@ -1559,6 +1647,8 @@ export type GetAssetDescription_FillBuffer = {
|
|
|
1559
1647
|
type?: 15;
|
|
1560
1648
|
};
|
|
1561
1649
|
export type GetAssetDescription_DrawDebugLines = {
|
|
1650
|
+
/** Specialization constants values for the specified shader */
|
|
1651
|
+
constantsJson?: object;
|
|
1562
1652
|
/** Data provided to the shader through the node data buffer */
|
|
1563
1653
|
dataJson?: object;
|
|
1564
1654
|
/** Description of a shader pipeline */
|
|
@@ -1567,9 +1657,11 @@ export type GetAssetDescription_DrawDebugLines = {
|
|
|
1567
1657
|
shaderRef?: string;
|
|
1568
1658
|
type?: 16;
|
|
1569
1659
|
};
|
|
1570
|
-
export type
|
|
1660
|
+
export type GetAssetDescription_DispatchDecals = {
|
|
1571
1661
|
/** Data provided to the shader through the node data buffer */
|
|
1572
1662
|
dataJson?: object;
|
|
1663
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
1664
|
+
shaderContextIndex: number;
|
|
1573
1665
|
type?: 17;
|
|
1574
1666
|
};
|
|
1575
1667
|
export type GetAssetDescription_SetDepthBias = {
|
|
@@ -1582,12 +1674,50 @@ export type GetAssetDescription_SetDepthBias = {
|
|
|
1582
1674
|
type?: 18;
|
|
1583
1675
|
};
|
|
1584
1676
|
export type GetAssetDescription_DispatchRayTracing = {
|
|
1677
|
+
/** Specialization constants values for the specified shader */
|
|
1678
|
+
constantsJson?: object;
|
|
1585
1679
|
/** Data provided to the shader through the node data buffer */
|
|
1586
1680
|
dataJson?: object;
|
|
1587
1681
|
/** Unique identifier for the asset */
|
|
1588
1682
|
shaderRef?: string;
|
|
1589
1683
|
type?: 19;
|
|
1590
1684
|
};
|
|
1685
|
+
export type GetAssetDescription_ParameterDescriptor = {
|
|
1686
|
+
/** Additional properties for a parameter of type "buffer": how many elements it holds, the size of each element, and how the buffer is used. Absent for every other parameter type */
|
|
1687
|
+
bufferProperties?: GetAssetDescription_BufferProperties;
|
|
1688
|
+
/** Categories */
|
|
1689
|
+
categories?: Array<string>;
|
|
1690
|
+
/** Parameter default value */
|
|
1691
|
+
default?: number | boolean | Array<number>;
|
|
1692
|
+
/** 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) */
|
|
1693
|
+
isReferenceResource?: boolean;
|
|
1694
|
+
/** Parameter name */
|
|
1695
|
+
name: string;
|
|
1696
|
+
/** Parameter native type */
|
|
1697
|
+
nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
|
|
1698
|
+
/** Parameter offset in bytes */
|
|
1699
|
+
offset: number;
|
|
1700
|
+
/** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
|
|
1701
|
+
properties?: GetAssetDescription_ParameterProperties;
|
|
1702
|
+
/** Parameter type */
|
|
1703
|
+
type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
|
|
1704
|
+
};
|
|
1705
|
+
export type GetAssetDescription_BufferProperties = {
|
|
1706
|
+
/** 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 */
|
|
1707
|
+
elementCount: StrictUnion<number | Array<number>>;
|
|
1708
|
+
/** Size in bytes of a single element in the buffer. If the buffer is declared as `T *buffer`, this is sizeof(T) */
|
|
1709
|
+
elementSize: number;
|
|
1710
|
+
/** How this buffer is going to be used */
|
|
1711
|
+
usage: number;
|
|
1712
|
+
};
|
|
1713
|
+
export type GetAssetDescription_ParameterProperties = {
|
|
1714
|
+
/** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
|
|
1715
|
+
format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
|
|
1716
|
+
/** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
|
|
1717
|
+
openMode?: 'read' | 'write' | 'readwrite';
|
|
1718
|
+
/** 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) */
|
|
1719
|
+
spec?: GetAssetDescription_Object;
|
|
1720
|
+
};
|
|
1591
1721
|
export type GetAssetDescription_Scene = {
|
|
1592
1722
|
/** Bounding box in local space */
|
|
1593
1723
|
aabb: GetAssetDescription_Aabb;
|
|
@@ -1617,24 +1747,128 @@ export type GetAssetDescription_Script = {
|
|
|
1617
1747
|
export type GetAssetDescription_Shader = {
|
|
1618
1748
|
/** The blend mode for the shader, used for batching purposes. Only valid for material shaders */
|
|
1619
1749
|
blendMode?: StrictUnion<0 | 1 | 2 | 3>;
|
|
1750
|
+
/** Compute shader settings. Only valid for compute shaders */
|
|
1751
|
+
computeSettings?: GetAssetDescription_ComputeShaderSettings;
|
|
1752
|
+
/** Data descriptor for specialization constants */
|
|
1753
|
+
constantDescriptor?: Array<GetAssetDescription_SpecializationConstantDescriptor>;
|
|
1754
|
+
/** GLSL extensions required by this shader, detected from the SPIR-V capabilities declared by its compiled modules */
|
|
1755
|
+
glslExtensions?: Array<GetAssetDescription_GlslExtension>;
|
|
1620
1756
|
/** Data descriptor for material shaders */
|
|
1621
|
-
materialDescriptor?: Array<
|
|
1757
|
+
materialDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1622
1758
|
/** Descriptions of all modules that compose this shader */
|
|
1623
|
-
moduleDescriptions
|
|
1759
|
+
moduleDescriptions?: Array<GetAssetDescription_ShaderModuleDescription>;
|
|
1624
1760
|
/** Name of the asset */
|
|
1625
1761
|
name: string;
|
|
1626
1762
|
/** Data descriptor for render graph node shaders */
|
|
1627
|
-
nodeDataDescriptor?: Array<
|
|
1628
|
-
/**
|
|
1629
|
-
|
|
1630
|
-
/** Vertex description. Only valid when a vertex shader module is present */
|
|
1631
|
-
optVertexDescriptor?: Array<GetAssetDescription_Object>;
|
|
1763
|
+
nodeDataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1764
|
+
/** Hash of the node data descriptor, used to detect changes in the descriptor */
|
|
1765
|
+
nodeDataDescriptorHash?: number;
|
|
1632
1766
|
/** The size in byte of the compiled shader code (accumulated size of all modules) */
|
|
1633
|
-
payloadSize
|
|
1767
|
+
payloadSize?: number;
|
|
1768
|
+
/** Reference to the shader context associated with this shader. Only present for shaders that use one. */
|
|
1769
|
+
shaderContextRef?: string;
|
|
1634
1770
|
/** Vulkan bit mask of all shader stages present in this shader */
|
|
1635
1771
|
shaderStages?: number;
|
|
1636
1772
|
/** Unique identifier for the asset */
|
|
1637
1773
|
uuid: string;
|
|
1774
|
+
/** Vertex description. Only valid when a vertex shader module is present */
|
|
1775
|
+
vertexDescriptor?: Array<GetAssetDescription_VertexAttributeDescriptor>;
|
|
1776
|
+
};
|
|
1777
|
+
export type GetAssetDescription_ComputeShaderSettings = {
|
|
1778
|
+
/** Global group reference */
|
|
1779
|
+
sizeReference?: StrictUnion<0 | 1 | 2>;
|
|
1780
|
+
/** Size of the workgroup */
|
|
1781
|
+
workgroupSize?: Array<number>;
|
|
1782
|
+
/** Scaling factor to apply to the total workgroup count */
|
|
1783
|
+
workloadScalingFactor?: Array<number>;
|
|
1784
|
+
};
|
|
1785
|
+
export type GetAssetDescription_SpecializationConstantDescriptor = {
|
|
1786
|
+
/** Constant default value */
|
|
1787
|
+
default: number | boolean;
|
|
1788
|
+
/** Description */
|
|
1789
|
+
description?: string;
|
|
1790
|
+
/** Display name */
|
|
1791
|
+
displayName?: string;
|
|
1792
|
+
/** Constant name */
|
|
1793
|
+
name: string;
|
|
1794
|
+
/** Constant type */
|
|
1795
|
+
type: 'bool' | 'int' | 'uint' | 'float';
|
|
1796
|
+
};
|
|
1797
|
+
export type GetAssetDescription_GlslExtension = {
|
|
1798
|
+
/** SPIR-V capability id that requires this extension (e.g. 5347 for PhysicalStorageBufferAddresses) */
|
|
1799
|
+
capabilityId: number;
|
|
1800
|
+
/** GLSL extension name, e.g. "GL_EXT_buffer_reference" */
|
|
1801
|
+
name: string;
|
|
1802
|
+
};
|
|
1803
|
+
export type GetAssetDescription_ShaderModuleDescription = {
|
|
1804
|
+
/** Names of the bindings used by this module */
|
|
1805
|
+
bindings?: Array<string>;
|
|
1806
|
+
/** Constants used by this module */
|
|
1807
|
+
constants?: GetAssetDescription_Object;
|
|
1808
|
+
/** Entry point of the shader module */
|
|
1809
|
+
entryPoint?: string;
|
|
1810
|
+
/** Outputs of this shader module (e.g. a fragment shader's color attachments, or the last stage's varying outputs), used to validate the module's compatibility with a render pipeline */
|
|
1811
|
+
outputs?: Array<GetAssetDescription_ShaderModuleOutputDescriptor>;
|
|
1812
|
+
/** Offset in byte in the shader payload buffer */
|
|
1813
|
+
payloadOffset: number;
|
|
1814
|
+
/** Size in byte of the compiled module */
|
|
1815
|
+
payloadSize: number;
|
|
1816
|
+
/** Push constant members used by this module, used to validate push constant layout compatibility across the pipeline's stages */
|
|
1817
|
+
pushConstants?: Array<GetAssetDescription_ShaderModulePushConstantDescriptor>;
|
|
1818
|
+
/** The shader stage */
|
|
1819
|
+
shaderStage: number;
|
|
1820
|
+
};
|
|
1821
|
+
export type GetAssetDescription_ShaderModuleOutputDescriptor = {
|
|
1822
|
+
/** Output location */
|
|
1823
|
+
location: number;
|
|
1824
|
+
/** Output variable name */
|
|
1825
|
+
name: string;
|
|
1826
|
+
/** Output variable type */
|
|
1827
|
+
type: 'bool' | 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'pointer';
|
|
1828
|
+
};
|
|
1829
|
+
export type GetAssetDescription_ShaderModulePushConstantDescriptor = {
|
|
1830
|
+
/** Push constant member name */
|
|
1831
|
+
name: string;
|
|
1832
|
+
/** Offset in byte within the push constant block */
|
|
1833
|
+
offset: number;
|
|
1834
|
+
/** Size in byte of the push constant member */
|
|
1835
|
+
size: number;
|
|
1836
|
+
/** Push constant member type */
|
|
1837
|
+
type: 'bool' | 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'pointer';
|
|
1838
|
+
};
|
|
1839
|
+
export type GetAssetDescription_VertexAttributeDescriptor = {
|
|
1840
|
+
/** Binding number */
|
|
1841
|
+
binding: number;
|
|
1842
|
+
/** Format */
|
|
1843
|
+
format: number;
|
|
1844
|
+
/** Location */
|
|
1845
|
+
location: number;
|
|
1846
|
+
/** Offset */
|
|
1847
|
+
offset: number;
|
|
1848
|
+
/** Semantic */
|
|
1849
|
+
semantic: StrictUnion<1 | 2 | 4 | 8 | 16 | 32> & number;
|
|
1850
|
+
/** Stride between consecutive elements within the buffer */
|
|
1851
|
+
stride: number;
|
|
1852
|
+
};
|
|
1853
|
+
export type GetAssetDescription_ShaderContext = {
|
|
1854
|
+
/** The fields every shader in this family reads as input */
|
|
1855
|
+
dataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1856
|
+
/** Name of the asset */
|
|
1857
|
+
name: string;
|
|
1858
|
+
/** The fields a material shader must produce. */
|
|
1859
|
+
outputDescriptor?: Array<GetAssetDescription_OutputFieldDescriptor>;
|
|
1860
|
+
/** Unique identifier for the asset */
|
|
1861
|
+
uuid: string;
|
|
1862
|
+
};
|
|
1863
|
+
export type GetAssetDescription_OutputFieldDescriptor = {
|
|
1864
|
+
/** Blend state of the attachment, no blending if absent */
|
|
1865
|
+
blendState?: GetAssetDescription_BlendState;
|
|
1866
|
+
/** What this field represents */
|
|
1867
|
+
description: string;
|
|
1868
|
+
/** Field name */
|
|
1869
|
+
name: string;
|
|
1870
|
+
/** Field data type */
|
|
1871
|
+
type: 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4';
|
|
1638
1872
|
};
|
|
1639
1873
|
export type GetAssetDescription_Skeleton = {
|
|
1640
1874
|
/** Descriptions of all bones forming the skeleton */
|
|
@@ -1725,8 +1959,8 @@ export type GetAssetDescription_VolumeMaterial = {
|
|
|
1725
1959
|
*/
|
|
1726
1960
|
export declare function getAssetDescription({ asset_id, asset_container, }: {
|
|
1727
1961
|
asset_id: string;
|
|
1728
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1729
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
|
1962
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1963
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_ShaderContext | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
|
1730
1964
|
export type UpdateAssetDescription_Cubemap = {
|
|
1731
1965
|
/** The 6 images forming the cube faces */
|
|
1732
1966
|
faces: Array<string>;
|
|
@@ -1745,7 +1979,9 @@ export type UpdateAssetDescription_Material = {
|
|
|
1745
1979
|
};
|
|
1746
1980
|
export type UpdateAssetDescription_RenderGraph = {
|
|
1747
1981
|
/** All blend states */
|
|
1748
|
-
blendStateDescriptions?: Array<
|
|
1982
|
+
blendStateDescriptions?: Array<UpdateAssetDescription_BlendState>;
|
|
1983
|
+
/** Descriptions of all buffers */
|
|
1984
|
+
bufferDescriptions?: Array<UpdateAssetDescription_Object>;
|
|
1749
1985
|
/** Conditions referenced by conditionIndex */
|
|
1750
1986
|
conditions?: Array<string>;
|
|
1751
1987
|
/** The index of the render target to blit into the canvas */
|
|
@@ -1757,40 +1993,54 @@ export type UpdateAssetDescription_RenderGraph = {
|
|
|
1757
1993
|
/** Name of the asset */
|
|
1758
1994
|
name: string;
|
|
1759
1995
|
/** Descriptions of all nodes */
|
|
1760
|
-
nodeDataDescriptions: Array<StrictUnion<UpdateAssetDescription_Viewport | UpdateAssetDescription_DrawBatch | UpdateAssetDescription_DrawBatchWithMaterials | UpdateAssetDescription_DispatchCompute | UpdateAssetDescription_BlitImage | UpdateAssetDescription_CopyImage | UpdateAssetDescription_ResolveImage | UpdateAssetDescription_DrawFullscreen |
|
|
1996
|
+
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>;
|
|
1761
1997
|
/** The index of the render target used for occlusion */
|
|
1762
1998
|
occlusionInputDepthRenderTargetIndex?: number;
|
|
1763
1999
|
/** Descriptions of all render passes */
|
|
1764
2000
|
renderPassDescriptions: Array<UpdateAssetDescription_Object>;
|
|
1765
2001
|
/** Descriptions of all render targets */
|
|
1766
2002
|
renderTargetDescriptions: Array<UpdateAssetDescription_Object>;
|
|
2003
|
+
/** Data descriptors for the shader contexts referenced by shaderContextIndex */
|
|
2004
|
+
shaderContexts?: Array<Array<UpdateAssetDescription_ParameterDescriptor>>;
|
|
1767
2005
|
/** All stencil states */
|
|
1768
2006
|
stencilOpStateDescriptions?: Array<UpdateAssetDescription_Object>;
|
|
1769
2007
|
};
|
|
1770
|
-
export type
|
|
1771
|
-
/**
|
|
2008
|
+
export type UpdateAssetDescription_BlendState = {
|
|
2009
|
+
/** Selects which blend operation is used to calculate the alpha values to write to the color attachment. */
|
|
1772
2010
|
alphaBlendOp?: number;
|
|
1773
|
-
/**
|
|
2011
|
+
/** 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. */
|
|
1774
2012
|
blendEnable?: boolean;
|
|
1775
|
-
/**
|
|
2013
|
+
/** Selects which blend operation is used to calculate the RGB values to write to the color attachment. */
|
|
1776
2014
|
colorBlendOp?: number;
|
|
1777
|
-
/** Color
|
|
2015
|
+
/** 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. */
|
|
1778
2016
|
colorWriteMask?: number;
|
|
1779
|
-
/**
|
|
2017
|
+
/** Selects which blend factor is used to determine the destination factor Da. */
|
|
1780
2018
|
dstAlphaBlendFactor?: number;
|
|
1781
|
-
/**
|
|
2019
|
+
/** Selects which blend factor is used to determine the destination factors (Dr,Dg,Db). */
|
|
1782
2020
|
dstColorBlendFactor?: number;
|
|
1783
|
-
/**
|
|
2021
|
+
/** Selects which blend factor is used to determine the source factor Sa. */
|
|
1784
2022
|
srcAlphaBlendFactor?: number;
|
|
1785
|
-
/**
|
|
2023
|
+
/** Selects which blend factor is used to determine the source factors (Sr,Sg,Sb). */
|
|
1786
2024
|
srcColorBlendFactor?: number;
|
|
1787
2025
|
};
|
|
2026
|
+
export type UpdateAssetDescription_Object = {
|
|
2027
|
+
/** 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 */
|
|
2028
|
+
elementCount?: StrictUnion<number | Array<number>>;
|
|
2029
|
+
/** Size in bytes of a single element in the buffer */
|
|
2030
|
+
elementSize?: number;
|
|
2031
|
+
/** Buffer name */
|
|
2032
|
+
name?: string;
|
|
2033
|
+
/** How this buffer is going to be used */
|
|
2034
|
+
usage?: number;
|
|
2035
|
+
};
|
|
1788
2036
|
export type UpdateAssetDescription_Viewport = {
|
|
1789
2037
|
type?: 0;
|
|
1790
2038
|
};
|
|
1791
2039
|
export type UpdateAssetDescription_DrawBatch = {
|
|
1792
|
-
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096 */
|
|
2040
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1793
2041
|
batchType?: number;
|
|
2042
|
+
/** Specialization constants values for the specified shader */
|
|
2043
|
+
constantsJson?: object;
|
|
1794
2044
|
/** Data provided to the shader through the node data buffer */
|
|
1795
2045
|
dataJson?: object;
|
|
1796
2046
|
/** Description of a shader pipeline */
|
|
@@ -1798,28 +2048,40 @@ export type UpdateAssetDescription_DrawBatch = {
|
|
|
1798
2048
|
type?: 1;
|
|
1799
2049
|
};
|
|
1800
2050
|
export type UpdateAssetDescription_DrawBatchWithMaterials = {
|
|
1801
|
-
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096 */
|
|
2051
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1802
2052
|
batchType?: number;
|
|
1803
2053
|
/** Data provided to the shader through the node data buffer */
|
|
1804
2054
|
dataJson?: object;
|
|
1805
2055
|
/** Description of a shader pipeline */
|
|
1806
2056
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
2057
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
2058
|
+
shaderContextIndex: number;
|
|
1807
2059
|
type?: 2;
|
|
1808
2060
|
};
|
|
1809
2061
|
export type UpdateAssetDescription_DispatchCompute = {
|
|
1810
2062
|
/** @deprecated Const data type */
|
|
1811
2063
|
constDataType?: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24> & number;
|
|
2064
|
+
/** Specialization constants values for the specified shader */
|
|
2065
|
+
constantsJson?: object;
|
|
1812
2066
|
/** Data provided to the shader through the node data buffer */
|
|
1813
2067
|
dataJson?: object;
|
|
1814
2068
|
type?: 3;
|
|
1815
2069
|
};
|
|
1816
2070
|
export type UpdateAssetDescription_BlitImage = {
|
|
2071
|
+
filter?: number;
|
|
1817
2072
|
/** Source render target */
|
|
1818
2073
|
inputRenderTargetIndices?: Array<number>;
|
|
1819
2074
|
/** Destination render target */
|
|
1820
2075
|
outputRenderTargetIndices?: Array<number>;
|
|
1821
2076
|
type?: 4;
|
|
1822
2077
|
};
|
|
2078
|
+
export type UpdateAssetDescription_DispatchPointClouds = {
|
|
2079
|
+
/** Specialization constants values for the specified shader */
|
|
2080
|
+
constantsJson?: object;
|
|
2081
|
+
/** Data provided to the shader through the node data buffer */
|
|
2082
|
+
dataJson?: object;
|
|
2083
|
+
type?: 5;
|
|
2084
|
+
};
|
|
1823
2085
|
export type UpdateAssetDescription_CopyImage = {
|
|
1824
2086
|
/** Source render target */
|
|
1825
2087
|
inputRenderTargetIndices?: Array<number>;
|
|
@@ -1835,15 +2097,20 @@ export type UpdateAssetDescription_ResolveImage = {
|
|
|
1835
2097
|
type?: 7;
|
|
1836
2098
|
};
|
|
1837
2099
|
export type UpdateAssetDescription_DrawFullscreen = {
|
|
2100
|
+
/** Specialization constants values for the specified shader */
|
|
2101
|
+
constantsJson?: object;
|
|
1838
2102
|
/** Data provided to the shader through the node data buffer */
|
|
1839
2103
|
dataJson?: object;
|
|
1840
2104
|
/** Description of a shader pipeline */
|
|
1841
2105
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1842
2106
|
type?: 8;
|
|
1843
2107
|
};
|
|
1844
|
-
export type
|
|
2108
|
+
export type UpdateAssetDescription_BlitMipChain = {
|
|
2109
|
+
filter?: number;
|
|
1845
2110
|
/** Source render target */
|
|
1846
2111
|
inputRenderTargetIndices?: Array<number>;
|
|
2112
|
+
/** Mip generation mode */
|
|
2113
|
+
mode?: StrictUnion<0 | 1> & number;
|
|
1847
2114
|
type?: 9;
|
|
1848
2115
|
};
|
|
1849
2116
|
export type UpdateAssetDescription_CopyToCubemapFace = {
|
|
@@ -1851,6 +2118,17 @@ export type UpdateAssetDescription_CopyToCubemapFace = {
|
|
|
1851
2118
|
inputRenderTargetIndices?: Array<number>;
|
|
1852
2119
|
type?: 10;
|
|
1853
2120
|
};
|
|
2121
|
+
export type UpdateAssetDescription_DispatchMipChain = {
|
|
2122
|
+
/** Specialization constants values for the specified shader */
|
|
2123
|
+
constantsJson?: object;
|
|
2124
|
+
/** Data provided to the shader through the node data buffer */
|
|
2125
|
+
dataJson?: object;
|
|
2126
|
+
/** Source render target */
|
|
2127
|
+
inputRenderTargetIndices?: Array<number>;
|
|
2128
|
+
/** Mip generation mode */
|
|
2129
|
+
mode?: StrictUnion<0 | 1> & number;
|
|
2130
|
+
type?: 11;
|
|
2131
|
+
};
|
|
1854
2132
|
export type UpdateAssetDescription_ClearImages = {
|
|
1855
2133
|
/** Clear colors */
|
|
1856
2134
|
clearColors?: Array<Array<number>>;
|
|
@@ -1870,15 +2148,19 @@ export type UpdateAssetDescription_FillBuffer = {
|
|
|
1870
2148
|
type?: 15;
|
|
1871
2149
|
};
|
|
1872
2150
|
export type UpdateAssetDescription_DrawDebugLines = {
|
|
2151
|
+
/** Specialization constants values for the specified shader */
|
|
2152
|
+
constantsJson?: object;
|
|
1873
2153
|
/** Data provided to the shader through the node data buffer */
|
|
1874
2154
|
dataJson?: object;
|
|
1875
2155
|
/** Description of a shader pipeline */
|
|
1876
2156
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1877
2157
|
type?: 16;
|
|
1878
2158
|
};
|
|
1879
|
-
export type
|
|
2159
|
+
export type UpdateAssetDescription_DispatchDecals = {
|
|
1880
2160
|
/** Data provided to the shader through the node data buffer */
|
|
1881
2161
|
dataJson?: object;
|
|
2162
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
2163
|
+
shaderContextIndex: number;
|
|
1882
2164
|
type?: 17;
|
|
1883
2165
|
};
|
|
1884
2166
|
export type UpdateAssetDescription_SetDepthBias = {
|
|
@@ -1891,10 +2173,48 @@ export type UpdateAssetDescription_SetDepthBias = {
|
|
|
1891
2173
|
type?: 18;
|
|
1892
2174
|
};
|
|
1893
2175
|
export type UpdateAssetDescription_DispatchRayTracing = {
|
|
2176
|
+
/** Specialization constants values for the specified shader */
|
|
2177
|
+
constantsJson?: object;
|
|
1894
2178
|
/** Data provided to the shader through the node data buffer */
|
|
1895
2179
|
dataJson?: object;
|
|
1896
2180
|
type?: 19;
|
|
1897
2181
|
};
|
|
2182
|
+
export type UpdateAssetDescription_ParameterDescriptor = {
|
|
2183
|
+
/** Additional properties for a parameter of type "buffer": how many elements it holds, the size of each element, and how the buffer is used. Absent for every other parameter type */
|
|
2184
|
+
bufferProperties?: UpdateAssetDescription_BufferProperties;
|
|
2185
|
+
/** Categories */
|
|
2186
|
+
categories?: Array<string>;
|
|
2187
|
+
/** Parameter default value */
|
|
2188
|
+
default?: number | boolean | Array<number>;
|
|
2189
|
+
/** 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) */
|
|
2190
|
+
isReferenceResource?: boolean;
|
|
2191
|
+
/** Parameter name */
|
|
2192
|
+
name: string;
|
|
2193
|
+
/** Parameter native type */
|
|
2194
|
+
nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
|
|
2195
|
+
/** Parameter offset in bytes */
|
|
2196
|
+
offset: number;
|
|
2197
|
+
/** Additional properties gating this parameter's relevance and/or driving how it's interpreted by tooling (e.g. the material editor) */
|
|
2198
|
+
properties?: UpdateAssetDescription_ParameterProperties;
|
|
2199
|
+
/** Parameter type */
|
|
2200
|
+
type: 'vec4' | 'ivec4' | 'quat' | 'color_alpha' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
|
|
2201
|
+
};
|
|
2202
|
+
export type UpdateAssetDescription_BufferProperties = {
|
|
2203
|
+
/** 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 */
|
|
2204
|
+
elementCount: StrictUnion<number | Array<number>>;
|
|
2205
|
+
/** Size in bytes of a single element in the buffer. If the buffer is declared as `T *buffer`, this is sizeof(T) */
|
|
2206
|
+
elementSize: number;
|
|
2207
|
+
/** How this buffer is going to be used */
|
|
2208
|
+
usage: number;
|
|
2209
|
+
};
|
|
2210
|
+
export type UpdateAssetDescription_ParameterProperties = {
|
|
2211
|
+
/** For a parameter of type "texture" or "render_target_index": the underlying pixel type's exact format */
|
|
2212
|
+
format?: 'int32' | 'uint32' | 'int64' | 'uint64' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'color3' | 'color4';
|
|
2213
|
+
/** For a parameter of type "buffer" or "render_target_index": how the underlying resource is accessed */
|
|
2214
|
+
openMode?: 'read' | 'write' | 'readwrite';
|
|
2215
|
+
/** 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) */
|
|
2216
|
+
spec?: UpdateAssetDescription_Object;
|
|
2217
|
+
};
|
|
1898
2218
|
/**
|
|
1899
2219
|
* Updates the description of the specified asset.
|
|
1900
2220
|
*/
|
|
@@ -1908,7 +2228,7 @@ export declare function updateAssetDescription({ asset_id, asset_container, asse
|
|
|
1908
2228
|
*/
|
|
1909
2229
|
export declare function renameAsset({ asset_id, asset_container, name, }: {
|
|
1910
2230
|
asset_id: string;
|
|
1911
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2231
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1912
2232
|
name?: string;
|
|
1913
2233
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
1914
2234
|
/**
|
|
@@ -1943,14 +2263,14 @@ export declare function updateAssetGraph({ asset_container_with_graph, asset_id,
|
|
|
1943
2263
|
* Gets the asset history from the specified asset.
|
|
1944
2264
|
*/
|
|
1945
2265
|
export declare function getAssetHistory({ asset_container, asset_id, }: {
|
|
1946
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2266
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1947
2267
|
asset_id: string;
|
|
1948
2268
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1949
2269
|
/**
|
|
1950
2270
|
* Gets the asset metadata from the specified asset.
|
|
1951
2271
|
*/
|
|
1952
2272
|
export declare function getAssetMeta({ asset_container, asset_id, }: {
|
|
1953
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2273
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1954
2274
|
asset_id: string;
|
|
1955
2275
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1956
2276
|
/**
|
|
@@ -1964,7 +2284,7 @@ export declare function getAssetCode({ asset_container_with_code, asset_id, }: {
|
|
|
1964
2284
|
* Gets the asset thumbnail from the specified asset.
|
|
1965
2285
|
*/
|
|
1966
2286
|
export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, size, default_url, }: {
|
|
1967
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2287
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1968
2288
|
asset_id: string;
|
|
1969
2289
|
size: 'large' | 'medium' | 'small' | 'tiny';
|
|
1970
2290
|
default_url?: string;
|
|
@@ -1973,7 +2293,7 @@ export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | '
|
|
|
1973
2293
|
* Assigns a thumbnail to the specified asset.
|
|
1974
2294
|
*/
|
|
1975
2295
|
export declare function setAssetThumbnail({ asset_container, asset_id, body, }: {
|
|
1976
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2296
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1977
2297
|
asset_id: string;
|
|
1978
2298
|
body: ArrayBuffer | ReadableStream;
|
|
1979
2299
|
}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
@@ -1988,7 +2308,7 @@ export declare function getAssetCustomTypes({ asset_container_with_custom_types,
|
|
|
1988
2308
|
* Packages and downloads the target asset.
|
|
1989
2309
|
*/
|
|
1990
2310
|
export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, }: {
|
|
1991
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2311
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1992
2312
|
asset_id: string;
|
|
1993
2313
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
1994
2314
|
/**
|