TiltFiveNative.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020-2023 Tilt Five, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
 
#include "errors.h"
#include "types.h"
 
#ifndef __cplusplus
#include <stddef.h>
#else
#include <cstddef>
#endif
 
#ifdef _WIN32
#ifdef BUILDING_T5_NATIVE_DLL
#ifdef __GNUC__
#define T5_EXPORT __attribute__((dllexport))
#else  // !__GNUC__
#define T5_EXPORT __declspec(dllexport)
#endif  // !__GNUC__
#else   // !BUILDING_T5_NATIVE_DLL
#define T5_EXPORT
#endif  // !BUILDING_T5_NATIVE_DLL
#else   // !_WIN32
#define T5_EXPORT __attribute__((visibility("default")))
#endif  // !_WIN32
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
 
T5_EXPORT T5_Result t5CreateContext(T5_Context* context,
                                    const T5_ClientInfo* clientInfo,
                                    void* platformContext);
 
T5_EXPORT void t5DestroyContext(T5_Context* context);
 
// C_Ctx
 
 
T5_EXPORT T5_Result t5ListGlasses(T5_Context context, char* buffer, size_t* bufferSize);
 
T5_EXPORT T5_Result t5CreateGlasses(T5_Context context, const char* id, T5_Glasses* glasses);
 
T5_EXPORT void t5DestroyGlasses(T5_Glasses* glasses);
 
 
T5_EXPORT T5_Result t5GetSystemIntegerParam(T5_Context context, T5_ParamSys param, int64_t* value);
 
T5_EXPORT T5_Result t5GetSystemFloatParam(T5_Context context, T5_ParamSys param, double* value);
 
T5_EXPORT T5_Result t5GetSystemUtf8Param(T5_Context context,
                                         T5_ParamSys param,
                                         char* buffer,
                                         size_t* bufferSize);
 
T5_EXPORT T5_Result t5GetChangedSystemParams(T5_Context context,
                                             T5_ParamSys* buffer,
                                             uint16_t* count);
 
T5_EXPORT T5_Result t5GetGameboardSize(T5_Context context,
                                       T5_GameboardType gameboardType,
                                       T5_GameboardSize* gameboardSize);
// C_Sys
 
 
 
T5_EXPORT T5_Result t5ReserveGlasses(T5_Glasses glasses, const char* displayName);
 
T5_EXPORT T5_Result t5SetGlassesDisplayName(T5_Glasses glasses, const char* displayName);
 
T5_EXPORT T5_Result t5EnsureGlassesReady(T5_Glasses glasses);
 
T5_EXPORT T5_Result t5ReleaseGlasses(T5_Glasses glasses);
 
T5_EXPORT T5_Result t5GetGlassesConnectionState(T5_Glasses glasses,
                                                T5_ConnectionState* connectionState);
 
T5_EXPORT T5_Result t5GetGlassesIdentifier(T5_Glasses glasses, char* buffer, size_t* bufferSize);
 
 
T5_EXPORT T5_Result t5GetGlassesPose(T5_Glasses glasses,
                                     T5_GlassesPoseUsage usage,
                                     T5_GlassesPose* pose);
 
T5_EXPORT T5_Result t5InitGlassesGraphicsContext(T5_Glasses glasses,
                                                 T5_GraphicsApi graphicsApi,
                                                 void* graphicsContext);
 
T5_EXPORT T5_Result t5ConfigureCameraStreamForGlasses(T5_Glasses glasses,
                                                      T5_CameraStreamConfig config);
 
//
T5_EXPORT T5_Result t5GetFilledCamImageBuffer(T5_Glasses glasses, T5_CamImage* image);
 
//
T5_EXPORT T5_Result t5SubmitEmptyCamImageBuffer(T5_Glasses glasses, T5_CamImage* image);
 
//
T5_EXPORT T5_Result t5CancelCamImageBuffer(T5_Glasses glasses, uint8_t* buffer);
 
//
T5_EXPORT T5_Result t5SendFrameToGlasses(T5_Glasses glasses, const T5_FrameInfo* info);
 
T5_EXPORT T5_Result t5ValidateFrameInfo(T5_Glasses glasses,
                                        const T5_FrameInfo* info,
                                        char* detail,
                                        size_t* detailSize);
 
 
T5_EXPORT T5_Result t5GetGlassesIntegerParam(T5_Glasses glasses,
                                             T5_WandHandle wand,
                                             T5_ParamGlasses param,
                                             int64_t* value);
 
T5_EXPORT T5_Result t5GetGlassesFloatParam(T5_Glasses glasses,
                                           T5_WandHandle wand,
                                           T5_ParamGlasses param,
                                           double* value);
 
T5_EXPORT T5_Result t5GetGlassesUtf8Param(T5_Glasses glasses,
                                          T5_WandHandle wand,
                                          T5_ParamGlasses param,
                                          char* buffer,
                                          size_t* bufferSize);
 
T5_EXPORT T5_Result t5GetChangedGlassesParams(T5_Glasses glasses,
                                              T5_ParamGlasses* buffer,
                                              uint16_t* count);
 
T5_EXPORT T5_Result t5GetProjection(T5_Glasses glasses,
                                    T5_CartesianCoordinateHandedness handedness,
                                    T5_DepthRange depthRange,
                                    T5_MatrixOrder matrixOrder,
                                    double nearPlane,
                                    double farPlane,
                                    double worldScale,
                                    T5_ProjectionInfo* projectionInfo);
 
 
T5_EXPORT T5_Result t5ListWandsForGlasses(T5_Glasses glasses,
                                          T5_WandHandle* buffer,
                                          uint8_t* count);
 
T5_EXPORT T5_Result t5SendImpulse(T5_Glasses glasses,
                                  T5_WandHandle wand,
                                  float amplitude,
                                  uint16_t duration);
 
T5_EXPORT T5_Result t5ConfigureWandStreamForGlasses(T5_Glasses glasses,
                                                    const T5_WandStreamConfig* config);
 
T5_EXPORT T5_Result t5ReadWandStreamForGlasses(T5_Glasses glasses,
                                               T5_WandStreamEvent* event,
                                               uint32_t timeoutMs);
 
// C_Gls
 
// C_Glasses_Interface
 
#ifdef __cplusplus
}
#endif
 
#undef T5_EXPORT