overlay.h

Go to the documentation of this file.

// Copyright 2023 Trimble Inc. All Rights Reserved.

#ifndef SKETCHUP_APPLICATION_OVERLAY_H_
#define SKETCHUP_APPLICATION_OVERLAY_H_

#include <SketchUpAPI/model/defs.h>
#include <SketchUpAPI/geometry.h>

#pragma pack(push, 8)

#ifdef __cplusplus
extern "C" {
#endif

typedef struct SUBoundingBox3D (*SUOverlayGetExtentsFuncT)(SUOverlayRef, void*);

enum SUOverlayBeginFrameInfoVersion : uint32_t {
  SUOVERLAY_BEGIN_FRAME_INFO_VERSION_1 = 1,
};

#define SUOVERLAY_BEGIN_FRAME_INFO_VERSION (SUOVERLAY_BEGIN_FRAME_INFO_VERSION_1)

struct SUBeginFrameInfo {
  enum SUOverlayBeginFrameInfoVersion version;

  struct SUPoint3D position;      
  struct SUPoint3D target;        
  struct SUVector3D up;           
  double aspect_ratio;            
  double near_clipping_distance;  
  double far_clipping_distance;   
  double projection_matrix[16];   
  double view_matrix[16];         
  double viewport_width;          
  double viewport_height;         

  double fov;

  double height;  
  bool is_perspective;  

  void* reserved;
};

typedef void (*SUOverlayBeginFrameFuncT)(SUOverlayRef, const struct SUBeginFrameInfo*, void*);

enum SUOverlayDrawFrameInfoVersion : uint32_t { SUOVERLAY_DRAW_FRAME_INFO_VERSION_1 = 1 };

#define SUOVERLAY_DRAW_FRAME_INFO_VERSION (SUOVERLAY_DRAW_FRAME_INFO_VERSION_1)

struct SUDrawFrameMemoryBuffer {
  void* ptr;
  uint32_t row_pitch;
  uint32_t size;
};

enum SUOverlayImageFormat : uint8_t {
  SUOVERLAY_IMAGE_FORMAT_RGBA = 0,
  SUOVERLAY_IMAGE_FORMAT_BGRA = 1,
};

enum SUOverlayImageOrientation : uint8_t {
  SUOVERLAY_IMAGE_ORIENTATION_TOP_DOWN = 0,
  SUOVERLAY_IMAGE_ORIENTATION_BOTTOM_UP = 1,
};

struct SUOverlayDrawFrameInfo {
  enum SUOverlayDrawFrameInfoVersion version;

  double blending_factor;

  struct SUDrawFrameMemoryBuffer color;

  struct SUDrawFrameMemoryBuffer depth;

  void* reserved;
};

typedef void (*SUOverlayDrawFrameFuncT)(SUOverlayRef, struct SUOverlayDrawFrameInfo*, void*);

typedef void (*SUOverlayEndFrameFuncT)(SUOverlayRef, void*);

typedef void (*SUOverlayStartFuncT)(SUOverlayRef, void*);

typedef void (*SUOverlayStopFuncT)(SUOverlayRef, void*);

enum SUOverlayCreateInfoVersion : uint32_t {
  SUOVERLAY_CREATE_INFO_VERSION_1 = 1,
};

#define SUOVERLAY_CREATE_INFO_VERSION (SUOVERLAY_CREATE_INFO_VERSION_1)

struct SUOverlayCreateInfo {
  enum SUOverlayCreateInfoVersion version;

  void* user_data;

  const char* id;
  const char* name;
  const char* desc;
  const char* source;

  enum SUOverlayImageFormat image_format;
  enum SUOverlayImageOrientation image_orientation;

  SUOverlayStartFuncT start;
  SUOverlayStopFuncT stop;
  SUOverlayGetExtentsFuncT get_extents;

  SUOverlayBeginFrameFuncT begin_frame;
  SUOverlayDrawFrameFuncT draw_frame;
  SUOverlayEndFrameFuncT end_frame;
};

SU_RESULT SUOverlayEnable(SUOverlayRef overlay, bool enabled);

#ifdef __cplusplus
}
#endif

#pragma pack(pop)

#endif  // SKETCHUP_APPLICATION_OVERLAY_H_