Varjo_types_mr_experimental.h

Go to the documentation of this file.

// Copyright 2020-2022 Varjo Technologies Oy. All rights reserved.
 
#ifndef VARJO_TYPES_MR_EXPERIMENTAL_H
#define VARJO_TYPES_MR_EXPERIMENTAL_H
 
#include "Varjo_types.h"
#include "Varjo_types_mr.h"
 
/*
 * *************** WARNING / DISCLAIMER ******************
 * Using these values is not guaranteed to work in the future. Please consult the MR team before using any of these.
 */
 
#if defined __cplusplus
extern "C" {
#endif
 
/*
 * Experimental API error codes
 */
 
static const varjo_Error varjo_Error_InvalidShaderType = 10100;
static const varjo_Error varjo_Error_InvalidShaderFormat = 10101;
static const varjo_Error varjo_Error_InvalidInputLayout = 10102;
static const varjo_Error varjo_Error_InvalidComputeBlockSize = 10103;
static const varjo_Error varjo_Error_InvalidSamplingMargin = 10104;
static const varjo_Error varjo_Error_InvalidConstantBufferSize = 10105;
static const varjo_Error varjo_Error_InvalidTextureDimensions = 10106;
static const varjo_Error varjo_Error_InvalidTextureFormat = 10107;
static const varjo_Error varjo_Error_InvalidTextureIndex = 10108;
static const varjo_Error varjo_Error_TextureNotAcquired = 10109;
static const varjo_Error varjo_Error_TexturesLocked = 10110;
static const varjo_Error varjo_Error_InvalidConstantBuffer = 10111;
static const varjo_Error varjo_Error_RenderAPINotInitialized = 10112;
static const varjo_Error varjo_Error_InvalidShaderFlags = 10113;
static const varjo_Error varjo_Error_InvalidShaderSize = 10114;
static const varjo_Error varjo_Error_InvalidShader = 10115;
static const varjo_Error varjo_Error_InvalidIndexCount = 10116;
static const varjo_Error varjo_Error_TextureLockFailed = 10117;
 
static const varjo_Error varjo_Error_InvalidVideoDepthTestMode = 10201;
static const varjo_Error varjo_Error_InvalidVideoDepthTestRange = 10202;
 
static const varjo_Error varjo_Error_ChunkContentsBufferAlreadyLocked = 10714;
static const varjo_Error varjo_Error_ChunkContentsBufferNotLocked = 10715;
static const varjo_Error varjo_Error_ChunkContentsBufferInvalidId = 10716;
static const varjo_Error varjo_Error_PointCloudSnapshotInvalidId = 10717;
 
 
/*
 * Experimental API lock types
 */
static const varjo_LockType varjo_LockType_VideoPostProcessShader = 1001;  
static const varjo_LockType varjo_LockType_VideoDepthTest = 1002;          
 
// =======================================================
// ============= Global Video Depth Test API =============
// =======================================================
 
typedef int64_t varjo_VideoDepthTestMode;
 
static const varjo_VideoDepthTestMode varjo_VideoDepthTestMode_Full = 0;
static const varjo_VideoDepthTestMode varjo_VideoDepthTestMode_LimitedRange = 1;
static const varjo_VideoDepthTestMode varjo_VideoDepthTestMode_ForcedRange = 2;
 
typedef int64_t varjo_VideoDepthTestBehavior;
 
static const varjo_VideoDepthTestBehavior varjo_VideoDepthTestBehavior_PreferLayerRange = 0;
static const varjo_VideoDepthTestBehavior varjo_VideoDepthTestBehavior_PreferVideoRange = 1;
static const varjo_VideoDepthTestBehavior varjo_VideoDepthTestBehavior_CombineRanges = 2;
 
 
// =========================================================
// ============= Video Post Process Shader API =============
// =========================================================
 
typedef int64_t varjo_ShaderType;
static const varjo_ShaderType varjo_ShaderType_VideoPostProcess = 1;
 
typedef int64_t varjo_ShaderFormat;
static const varjo_ShaderFormat varjo_ShaderFormat_None = 0;
static const varjo_ShaderFormat varjo_ShaderFormat_DxComputeBlob = 1;
 
typedef int64_t varjo_ShaderInputLayout;
 
static const varjo_ShaderInputLayout varjo_ShaderInputLayout_VideoPostProcess_V2 = 2;
 
typedef int64_t varjo_ShaderFlags_VideoPostProcess;
static const varjo_ShaderFlags_VideoPostProcess varjo_ShaderFlag_VideoPostProcess_None = 0;
 
struct varjo_TextureConfig {
    varjo_TextureFormat format;
    uint64_t width;
    uint64_t height;
};
 
struct varjo_ShaderParams_VideoPostProcess {
    varjo_ShaderFlags_VideoPostProcess inputFlags;  
    int64_t computeBlockSize;                       
    int64_t samplingMargin;                         
    int64_t constantBufferSize;                     
    struct varjo_TextureConfig textures[16];        
};
 
union varjo_ShaderParams {
    struct varjo_ShaderParams_VideoPostProcess videoPostProcess;  
    int64_t reserved[128];                                        
};
 
struct varjo_ShaderConfig {
    varjo_ShaderFormat format;            
    varjo_ShaderInputLayout inputLayout;  
    union varjo_ShaderParams params;      
};
 
/*
 * DXGI texture format type. This is DXGI_FORMAT type, but we don't want to include dxghi.h for this here.
 */
typedef uint32_t varjo_DXGITextureFormat;
 
/*
 * OpenGL texture format structure. Formats are GLenum type, but we don't want to include GL.h for this here.
 */
struct varjo_GLTextureFormat {
    uint32_t baseFormat;      
    uint32_t internalFormat;  
};
 
// =====================================================================
// ================= 3D reconstruction point cloud API =================
// =====================================================================
 
typedef int32_t varjo_ChunkContentsBufferId;
static const varjo_ChunkContentsBufferId varjo_ChunkContentsBufferId_Invalid = -1;
 
static const varjo_PropertyKey varjo_PropertyKey_ReconstructionAvailable = 0xFF01;  
 
typedef int64_t varjo_PointCloudSnapshotId;
static const int64_t varjo_PointCloudSnapshotId_Invalid = 0;
 
typedef int64_t varjo_PointCloudSnapshotStatus;
static const int64_t varjo_PointCloudSnapshotStatus_Invalid = 0;  
static const int64_t varjo_PointCloudSnapshotStatus_Pending = 1;  
static const int64_t varjo_PointCloudSnapshotStatus_Ready = 2;    
 
struct varjo_ReconstructionConfig {
    int32_t framerate;  
    int32_t reserved[31];
};
 
struct varjo_PointCloudPoint {
    uint32_t indexConfidence;  
    uint32_t normalXY;         
    uint32_t normalZcolorR;    
    uint32_t colorBG;          
    uint32_t positionXY;       
    uint32_t positionZradius;  
};
 
struct varjo_PointCloudSnapshotContent {
    struct varjo_PointCloudPoint* points;  
    int32_t pointCount;                    
    int32_t sequenceNumber;                
    varjo_Nanoseconds timestamp;           
};
 
struct varjo_PointCloudDeltaContent {
    struct varjo_PointCloudPoint* changedPoints;  
    int32_t* removedPointIds;                     
    int32_t changedPointCount;                    
    int32_t removedPointCount;                    
    int32_t maxSurfelIndex;                       
    int32_t sequenceNumber;                       
    varjo_Nanoseconds timestamp;                  
};
 
// =================================================================
// ================= 3D reconstruction meshing API =================
// =================================================================
 
typedef int64_t varjo_MeshChunkContentsBufferId;
static const varjo_MeshChunkContentsBufferId varjo_MeshChunkContentsBufferId_Invalid = -1;
 
 
typedef int64_t varjo_VertexAttribute;
// static const varjo_VertexAttribute varjo_VertexAttribute_off = 0;
static const varjo_VertexAttribute varjo_VertexAttribute_float32 = 1;
// static const varjo_VertexAttribute varjo_VertexAttribute_float16 = 2;
// static const varjo_VertexAttribute varjo_VertexAttribute_rgbe = 3;
 
struct varjo_VertexFormat {
    varjo_VertexAttribute position;
    varjo_VertexAttribute color;
    varjo_VertexAttribute normal;
    int64_t reserved[13];
};
 
struct varjo_MeshReconstructionConfig {
    struct varjo_VertexFormat vertexFormat;  
    uint32_t chunksPerMeter;                 
    uint32_t maxVerticesPerChunk;            
    uint32_t maxTrianglesPerChunk;           
    uint32_t maxChunks;                      
    uint32_t reserved[13];
};
 
struct varjo_MeshChunkDescription {
    struct varjo_Vector3Di position;    
    varjo_Nanoseconds updateTimestamp;  
    uint32_t vertexCount;               
    uint32_t triangleCount;             
    uint32_t reserved[34];
};
 
union varjo_MeshVertexPositionArray {
    struct varjo_Vector3Df* positions32f;
};
 
union varjo_MeshVertexColorArray {
    struct varjo_Vector3Df* colors32f;
};
 
union varjo_MeshVertexNormalArray {
    struct varjo_Vector3Df* normals32f;
};
 
struct varjo_MeshChunkContent {
    struct varjo_MeshChunkDescription description;
    uint32_t* triangleIndices;  
    union varjo_MeshVertexPositionArray vertexPositions;  
    union varjo_MeshVertexColorArray vertexColors;        
    union varjo_MeshVertexNormalArray vertexNormals;      
    uint32_t reserved[18];
};
 
#if defined __cplusplus
}
#endif
 
#endif  // VARJO_TYPES_MR_EXPERIMENTAL_H