Native 3D CORE API v1

Field API reference

API reference

Reference scope

This page contains every public function declared in core/native3d/include/native_3d_field_api_v1.h in dev-40. Signatures are reproduced from the header; nearby header comments are shown when present. Use the conceptual guide pages for behavior that is shared across a family.

Field operations (6)

Field operations 6 functions

gx3de_field_source_info_get

GX3DE_API gx3de_result gx3de_field_source_info_get(gx3de_object *field,gx3de_field_source_info *out);
Reports interpolation support without reading or changing source arrays.
Source: core/native3d/include/native_3d_field_api_v1.h:24

gx3de_field_lines_create

GX3DE_API gx3de_result gx3de_field_lines_create(gx3de_scene *scene, const gx3de_field_line_spec *spec, gx3de_object **out_lines, gx3de_field_line_info *out_info);
Creates a queryable scientific polyline object in the field scene. Derived points are immutable and parented to the source field for hierarchy pose; regenerate when field data or seeds change. No partial object is published on budget or input failure.
Source: core/native3d/include/native_3d_field_api_v1.h:64

gx3de_field_slice_create

GX3DE_API gx3de_result gx3de_field_slice_create(gx3de_scene *scene, const gx3de_field_slice_spec *spec, gx3de_object **out_slice);
A fully in-domain slice, sampled bilinearly/trilinearly from the supplied grid, returned as an ordinary scalar-colored scientific triangle surface. Out-of-domain samples reject the entire slice, with no partial publication.
Source: core/native3d/include/native_3d_field_api_v1.h:80

gx3de_field_pathlines_create

GX3DE_API gx3de_result gx3de_field_pathlines_create(gx3de_scene *scene, const gx3de_field_pathline_spec *spec, gx3de_object **out_lines, gx3de_field_pathline_info *out_info);
Pathline coordinates satisfy dx/dt = v(x,t), unlike stationary streamlines. Time interpolation is linear between immutable input vector samples. Output has point array "field_scalar" if supplied and "time_value".
Source: core/native3d/include/native_3d_field_api_v1.h:117

gx3de_field_volume_style_set

GX3DE_API gx3de_result gx3de_field_volume_style_set(gx3de_object *image, const gx3de_field_volume_style *style);
Rendering presentation state only; the image array remains immutable. Isosurfaces, slices, clouds, and volume can coexist as separate layers.
Source: core/native3d/include/native_3d_field_api_v1.h:135

gx3de_field_volume_style_get

GX3DE_API gx3de_result gx3de_field_volume_style_get(gx3de_object *image, gx3de_field_volume_style *style);
Source: core/native3d/include/native_3d_field_api_v1.h:137