base.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2026 Jeremiah van Oosten
 *
 * vgl base header: export macros, basic types, result codes and version.
 * See docs/c-api.md for the conventions every declaration follows.
 */
#ifndef VGL_BASE_H
#define VGL_BASE_H
 
#include <vgl/version.h>
 
#include <stddef.h>
#include <stdint.h>
 
/* Symbol visibility. VGL_SHARED is defined for consumers of a shared build. */
#if defined(VGL_SHARED)
#    if defined(_WIN32)
#        if defined(VGL_BUILDING)
#            define VGL_API __declspec(dllexport)
#        else
#            define VGL_API __declspec(dllimport)
#        endif
#    else
#        define VGL_API __attribute__((visibility("default")))
#    endif
#else
#    define VGL_API
#endif
 
/* Marks a declaration as deprecated (docs/c-api.md, section 14.4). */
#if defined(_MSC_VER)
#    define VGL_DEPRECATED(message) __declspec(deprecated(message))
#elif defined(__GNUC__) || defined(__clang__)
#    define VGL_DEPRECATED(message) __attribute__((deprecated(message)))
#else
#    define VGL_DEPRECATED(message)
#endif
 
/*
 * Pads a pointer field to 8 bytes on targets with 32-bit pointers. Placed after each pointer
 * in a structure that also holds 64-bit fields, it gives the structure the same layout, without
 * implicit padding, on every target (docs/c-api.md, section 8.2).
 */
#if UINTPTR_MAX == UINT32_MAX
#    define VGL_POINTER_PADDING(name) uint32_t name;
#else
#    define VGL_POINTER_PADDING(name)
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint32_t vgl_bool;
 
#define VGL_FALSE 0u
#define VGL_TRUE  1u
 
typedef struct vgl_dvec2
{
    double x;
    double y;
} vgl_dvec2;
 
typedef struct vgl_dvec3
{
    double x;
    double y;
    double z;
} vgl_dvec3;
 
typedef struct vgl_dvec4
{
    double x;
    double y;
    double z;
    double w;
} vgl_dvec4;
 
typedef struct vgl_dmat4
{
    double m[16];
} vgl_dmat4;
 
typedef enum vgl_result
{
    VGL_RESULT_SUCCESS = 0,
    VGL_RESULT_INCOMPLETE = 1,
    VGL_RESULT_NOT_READY = 2,
    VGL_RESULT_INVALID_ARGUMENT = -1,
    VGL_RESULT_OUT_OF_MEMORY = -2,
    VGL_RESULT_NOT_SUPPORTED = -3,
    VGL_RESULT_INVALID_OPERATION = -4,
    VGL_RESULT_NOT_FOUND = -5,
    VGL_RESULT_IO_ERROR = -6,
    VGL_RESULT_CORRUPT_DATA = -7,
    VGL_RESULT_VERSION_MISMATCH = -8,
    VGL_RESULT_CANCELLED = -9,
    VGL_RESULT_BACKEND_ERROR = -10,
    VGL_RESULT_INTERNAL_ERROR = -11,
    VGL_RESULT_MAX_ENUM = 0x7FFFFFFF
} vgl_result;
 
#define VGL_SUCCEEDED(result) ((result) >= 0)
#define VGL_FAILED(result) ((result) < 0)
 
VGL_API vgl_result vgl_result_name_get(vgl_result result, const char** out_name);
 
VGL_API vgl_result vgl_version_get(uint32_t* out_major, uint32_t* out_minor, uint32_t* out_patch);
 
#ifdef __cplusplus
}
#endif
 
#endif /* VGL_BASE_H */