BlinkTypes.h

Go to the documentation of this file.

// Copyright (c) 2013 The Foundry Visionmongers Ltd.  All Rights Reserved.

#ifndef Blink_Library_BlinkTypes_h
#define Blink_Library_BlinkTypes_h
#ifdef __cplusplus
extern "C" {
#endif

typedef long long BlinkFlagType;

typedef BlinkFlagType BlinkCodegenFlags;
typedef BlinkFlagType BlinkDataType;
typedef BlinkFlagType BlinkPropertyType;
typedef BlinkFlagType BlinkErrorProperty;

// Kernel type (Iteration, Rolling, etc...)
typedef BlinkFlagType BlinkKernelType;

typedef BlinkFlagType BlinkKernelGranularity;

// Type of image access (Read or write)
typedef BlinkFlagType BlinkImageAccessType;

// Pattern (Point, Ranged1D, etc...)
typedef BlinkFlagType BlinkImagePatternType;
typedef BlinkFlagType BlinkAxisType;

// Edge (Constant, Clamped, ...)
typedef BlinkFlagType BlinkImageEdgeType;

struct BlinkObj;
typedef struct BlinkObj* BlinkRef;
typedef struct BlinkObj* BlinkErrorRef;

typedef int BlinkErrorCode;

typedef void* BlinkComputeDeviceID;

typedef int BlinkMemoryType;

struct BlinkRect {
  int x1;
  int y1;
  int x2;
  int y2;
};

struct BlinkPixelInfo {
  int nComponents;

  BlinkDataType dataType;
};

struct BlinkImageInfo {
  struct BlinkRect bounds;

  struct BlinkPixelInfo pixelInfo;
};

struct BlinkKernelIterationController {

  struct BlinkRect bounds;

  //TODO component range? Step size?
};

struct BlinkBufferDesc {
  unsigned long long pixelStepBytes;
  unsigned long long rowStepBytes;
  unsigned long long componentStepBytes;
};

struct BlinkDeviceMemory {
  //Type of memory
  BlinkMemoryType type;

  //Pointer to the memory base object. For host memory this would be a pointer to the memory pointer i.e. a void**
  void* memoryBasePtr;
  // Size of memory base object
  unsigned long long memoryBaseSize;

  // Offset into memory - currently this must be zero
  unsigned long long offset;
};

struct BlinkKernelInfo {
  // Name of the kernel
  const char* kernelName;
  
  // Type of the kernel (ImageComputation, Rolling, etc...)
  BlinkKernelType kernelType;
  
  BlinkKernelGranularity kernelGranularity;
};

struct BlinkKernelImageInfo {
  // Name of the image
  const char* name;
  
  // Access type (eRead or eWrite)
  BlinkImageAccessType accessType;
  
  // Pattern type (ePoint, eRanged1D, etc...)
  BlinkImagePatternType patternType;
  
  // Edge Type (eEdgeNone, eEdgeClamp, etc...)
  BlinkImageEdgeType edgeType;
};

struct BlinkKernelParameterInfo {
  const char* name;
  
  BlinkDataType type;
  
  unsigned nComponents;
  
  unsigned nElements;
};

struct BlinkImageAccessDesc
{
  BlinkImagePatternType patternType;
  BlinkAxisType axis;
  struct BlinkRect range;
};

#ifdef __cplusplus
}
#endif
#endif