occtl_io_gltf.h

Go to the documentation of this file.

// Copyright (c) 2026 Capgemini Engineering Research and Development.
//
// This file is part of OCCT-Light software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Affero General Public License version 3 as published
// by the Free Software Foundation, with an option to use any later version.
// Consult the file LICENSE_AGPL_30.txt included in OCCT-Light distribution
// for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of a commercial
// license or contractual agreement.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#ifndef OCCTL_IO_GLTF_H
#define OCCTL_IO_GLTF_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum occtl_io_gltf_transform_format
{
  OCCTL_IO_GLTF_TRANSFORM_COMPACT = 0, 
  OCCTL_IO_GLTF_TRANSFORM_MAT4    = 1, 
  OCCTL_IO_GLTF_TRANSFORM_TRS     = 2, 
  OCCTL_IO_GLTF_TRANSFORM_RESERVED_FUTURE = 0x7fffffff
} occtl_io_gltf_transform_format_t;
 
#define OCCTL_IO_GLTF_READ_OPTIONS_VERSION_1 1u
#define OCCTL_IO_GLTF_WRITE_OPTIONS_VERSION_1 1u
 
typedef struct occtl_io_gltf_read_options
{
  uint32_t    struct_version;        
  const void* p_next;                
  int32_t     load_all_scenes;       
  int32_t     skip_empty_nodes;      
  int32_t use_mesh_name_as_fallback; 
  int32_t apply_scale;               
  int32_t parallel;                  
  int32_t single_precision;          
  int32_t fill_incomplete;  
  int32_t memory_limit_mib; 
} occtl_io_gltf_read_options_t;
 
#define OCCTL_IO_GLTF_READ_OPTIONS_INIT                                                            \
  {OCCTL_IO_GLTF_READ_OPTIONS_VERSION_1, NULL, 0, 1, 1, 1, 0, 1, 1, -1}
 
typedef struct occtl_io_gltf_write_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  occtl_io_gltf_transform_format_t transform_format; 
  int32_t force_uv_export;       
  int32_t embed_textures_in_glb; 
  int32_t merge_faces;           
  int32_t split_indices_16;      
  int32_t parallel;              
} occtl_io_gltf_write_options_t;
 
#define OCCTL_IO_GLTF_WRITE_OPTIONS_INIT                                                           \
  {OCCTL_IO_GLTF_WRITE_OPTIONS_VERSION_1, NULL, OCCTL_IO_GLTF_TRANSFORM_COMPACT, 0, 1, 0, 0, 0}
 
OCCTL_API void OCCTL_CALL occtl_io_gltf_read_options_init(occtl_io_gltf_read_options_t* options);
 
OCCTL_API void OCCTL_CALL occtl_io_gltf_write_options_init(occtl_io_gltf_write_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_io_gltf_read(const char*      path,
                                                       occtl_graph_t**  out_graph,
                                                       occtl_node_id_t* out_root,
                                                       const occtl_io_gltf_read_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_io_gltf_write(const occtl_graph_t*                 graph,
                      occtl_node_id_t                      root,
                      const char*                          path,
                      const occtl_io_gltf_write_options_t* options);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_IO_GLTF_H */