IrisTypes.hpp

Go to the documentation of this file.

 
#ifndef IrisTypes_h
#define IrisTypes_h
 
namespace Iris {
enum Result : uint32_t {
    IRIS_SUCCESS        = 0,
    IRIS_FAILURE        = 0x00000001,
    IRIS_UNINITIALIZED  = 0x00000002,
};
enum BufferReferenceStrength {
    REFERENCE_WEAK      = 0,
    REFERENCE_STRONG    = 1,
};
using Buffer = std::shared_ptr<class __INTERNAL__Buffer>;
using Viewer = std::shared_ptr <class __INTERNAL__Viewer>;
using Slide  = std::shared_ptr<class  __INTERNAL__Slide>;
 
struct ViewerCreateInfo {
    const char*         ApplicationName;
    uint32_t            ApplicationVersion;
    const char*         ApplicationBundlePath;
};
struct ViewerBindExternalSurfaceInfo {
    const Viewer        viewer      = nullptr;  
#if defined _WIN32
    HINSTANCE           instance    = NULL;    
    HWND                window      = NULL;    
#elif defined __APPLE__
    const void*         layer       = nullptr; 
#endif
};
struct ViewerTranslateScope {
    float               x_translate = 0.f;
    float               y_translate = 0.f;
    float               x_velocity  = 0.f;
    float               y_velocity  = 0.f;
};
struct ViewerZoomScope {
    float               increment   = 0.f;
    float               x_location  = 0.5f;
    float               y_location  = 0.5f;
};
enum AnnotationFormat {
    ANNOTATION_FORMAT_UNDEFINED     = -1,
    ANNOTATION_FORMAT_PNG,
    ANNOTATION_FORMAT_JPEG,
};
struct SlideAnnotation {
    AnnotationFormat    format      = ANNOTATION_FORMAT_UNDEFINED;
    float               x_offset    = 0.f;
    float               y_offset    = 0.f;
    float               width       = 0.f;
    float               height      = 0.f;
    Buffer              data;
};
struct LayerExtent {
    uint32_t            xTiles      = 1; 
    uint32_t            yTiles      = 1; 
    float               scale       = 1.f;
    float               downsample  = 1.f;
};
using LayerExtents = std::vector<LayerExtent>;
struct Extent {
    uint32_t            width       = 1; 
    uint32_t            height      = 1; 
    LayerExtents        layers; 
};
enum Format {
    FORMAT_UNDEFINED,
    FORMAT_B8G8R8,
    FORMAT_R8G8B8,
    FORMAT_B8G8R8A8,
    FORMAT_R8G8B8A8,
};
struct LocalSlideOpenInfo {
    const char*         filePath;
    enum : uint8_t {
        SLIDE_TYPE_UNKNOWN,         //< Unknown file encoding
        SLIDE_TYPE_IRIS,            //< Iris Codec File
        SLIDE_TYPE_OPENSLIDE,       //< Vendor specific file (ex SVS)
    }                   type        = SLIDE_TYPE_UNKNOWN;
    
};
struct NetworkSlideOpenInfo {
    const char*         slideID;
};
struct SlideOpenInfo {
    enum : uint8_t {
        SLIDE_OPEN_UNDEFINED,           // Default / invalid file
        SLIDE_OPEN_LOCAL,               // Locally accessible / Mapped File
        SLIDE_OPEN_NETWORK,             // Sever hosted slide file
    }                   type            = SLIDE_OPEN_UNDEFINED;
    union {
    LocalSlideOpenInfo   local;
    NetworkSlideOpenInfo network;
    };
    // ~~~~~~~~~~~~~ OPTIONAL FEATURES ~~~~~~~~~~~~~~~ //
    size_t               capacity       = 1000;
};
using LambdaPtr         = std::function<void()>;
using LambdaPtrs        = std::vector<LambdaPtr>;
} // END IRIS NAMESPACE
 
#endif /* IrisTypes_h */