Baillehache Pascal's personal website

LibCapy - image

2D image class.

Macros:

#define CAPY_IMAGE_H

#define CapyImgDims_                               \
  union {                                          \
    CapyImgDims_t vals[2];                         \
    struct __attribute__((packed)) {               \
      CapyImgDims_t width; CapyImgDims_t height;}; \
  }

Definition of the dimensions of an image

#define CapyImgPos_                      \
  union {                                \
    CapyImgPos_t coords[2];              \
    struct __attribute__((packed)) {     \
      CapyImgPos_t x; CapyImgPos_t y;};  \
  }

Definition of a position in the image (from left to right and top to bottom)

#define CapyImgCreate_Greyscale_800x600() \
  CapyImgCreate(capyImgMode_greyscale, capyImgDims_800x600)

Shortcuts for CapyImgCreate()

#define CapyImgCreate_Greyscale_600x800() \
  CapyImgCreate(capyImgMode_scale, capyImgDims_600x800)

#define CapyImgCreate_RGB_800x600() \
  CapyImgCreate(capyImgMode_rgb, capyImgDims_800x600)

#define CapyImgCreate_RGB_600x800() \
  CapyImgCreate(capyImgMode_rgb, capyImgDims_600x800)

#define CapyImgCreate_RGBA_800x600() \
  CapyImgCreate(capyImgMode_rgba, capyImgDims_800x600)

#define CapyImgCreate_RGBA_600x800() \
  CapyImgCreate(capyImgMode_rgba, capyImgDims_600x800)

#define CapyImgCreate_HLS_800x600() \
  CapyImgCreate(capyImgMode_hls, capyImgDims_800x600)

#define CapyImgCreate_HLS_600x800() \
  CapyImgCreate(capyImgMode_hls, capyImgDims_600x800)

#define CapyImgAlloc_Greyscale_800x600() \
  CapyImgAlloc(capyImgMode_greyscale, capyImgDims_800x600)

Shortcuts for CapyImgAlloc()

#define CapyImgAlloc_Greyscale_600x800() \
  CapyImgAlloc(capyImgMode_scale, capyImgDims_600x800)

#define CapyImgAlloc_RGB_800x600() \
  CapyImgAlloc(capyImgMode_rgb, capyImgDims_800x600)

#define CapyImgAlloc_RGB_600x800() \
  CapyImgAlloc(capyImgMode_rgb, capyImgDims_600x800)

#define CapyImgAlloc_RGBA_800x600() \
  CapyImgAlloc(capyImgMode_rgba, capyImgDims_800x600)

#define CapyImgAlloc_RGBA_600x800() \
  CapyImgAlloc(capyImgMode_rgba, capyImgDims_600x800)

#define CapyImgAlloc_HLS_800x600() \
  CapyImgAlloc(capyImgMode_hls, capyImgDims_800x600)

#define CapyImgAlloc_HLS_600x800() \
  CapyImgAlloc(capyImgMode_hls, capyImgDims_600x800)

Enumerations:

typedef enum CapyImgMode {
  capyImgMode_greyscale,
  capyImgMode_rgb,
  capyImgMode_rgba,
  capyImgMode_hsv
} CapyImgMode;

Enumeration of image modes

typedef enum CapyImgNeighbour {
  capyImgNeighbour_top,
  capyImgNeighbour_right,
  capyImgNeighbour_bottom,
  capyImgNeighbour_left,
  capyImgNeighbour_topLeft,
  capyImgNeighbour_topRight,
  capyImgNeighbour_bottomRight,
  capyImgNeighbour_bottomLeft,
  capyImgNeighbour_last,
} CapyImgNeighbour;

Enumeration to identify the neighours of a pixel

typedef enum CapyImgIteratorType {
  capyImgIteratorType_LeftToRight_TopToBottom,
} CapyImgIteratorType;

Enumeration for the types of iterator on a CapyImg

Typedefs:

typedef uint32_t CapyImgDims_t;

Type for the size of an image (choosen to match png_uint_32)

typedef CapyImgDims_ CapyImgDims;

Dimensions of an image

typedef int32_t CapyImgPos_t;

Type to store a pixel coordinate (should be the signed version of CapyImgDims_t)

typedef CapyImgPos_ CapyImgPos;

Position in the image (from left to right and top to bottom)

typedef struct CapyImg CapyImg;

CapyImg object predeclaration

typedef struct CapyImg CapyImg;

CapyImg object

Struct CapyImgPixel :

Struct CapyImgPixel's properties:

  CapyImgPos pos;

Position

  size_t idx;

Index in the array of pixels

  CapyColorData* color;

Color data

Struct CapyImgPixel's methods:

None.

Struct CapyImgIterator :

Struct CapyImgIterator's properties:

  size_t idx;

Index of the current step in the iteration

  CapyImgPixel datatype;

Returned data type

  CapyImgPixel pixel;

Current pixel of the iteration

  CapyImgIteratorType type;

Type of iteration

  CapyPad(CapyImgIteratorType, type);

  CapyImg* img;

Image associated to the iteration

Struct CapyImgIterator's methods:

  void (*destruct)(void);

Destructor

  CapyImgPixel* (*reset)(void);

Reset the iterator

Output and side effect(s):

Return the first pixel of the iteration

  CapyImgPixel* (*prev)(void);

Move the iterator to the previous pixel

Output and side effect(s):

Return the previous pixel of the iteration

  CapyImgPixel* (*next)(void);

Move the iterator to the next pixel

Output and side effect(s):

Return the next pixel of the iteration

  bool (*isActive)(void);

Check if the iterator is on a valid pixel

Output and side effect(s):

Return true if the iterator is on a valid pixel, else false

  CapyImgPixel* (*get)(void);

Get the current pixel of the iteration

Output and side effect(s):

Return a pointer to the current pixel

  void (*setType)(CapyImgIteratorType const type);

Set the type of the iterator and reset it

Input argument(s):

type: the new type of the iterator

Functions:

CapyImgIterator CapyImgIteratorCreate(
             CapyImg* const img,
  CapyImgIteratorType const type);

Create an iterator on a CapyImg

Input argument(s):

img: the image on which to iterate
type: the type of iterator

Output and side effect(s):

Return the iterator

CapyImgIterator* CapyImgIteratorAlloc(
             CapyImg* const img,
  CapyImgIteratorType const type);

Allocate memory and create an iterator on a CapyImg

Input argument(s):

img: the image on which to iterate
type: the type of iterator

Output and side effect(s):

Return the iterator

void CapyImgIteratorFree(CapyImgIterator** const that);

Free the memory used by a pointer to an iterator and reset '*that' to NULL

Input argument(s):

that: a pointer to the iterator to free

CapyImg CapyImgCreate(
  CapyImgMode const mode,
  CapyImgDims const dims);

Create a CapyImg of given dimensions and mode

Input argument(s):

mode: mode of the image
dims: dimensions of the image

Output and side effect(s):

Return a CapyImg initialised to rgba opaque white

Exception(s):

May raise CapyExc_MallocFailed.

CapyImg* CapyImgAlloc(
  CapyImgMode const mode,
  CapyImgDims const dims);

Allocate memory for a new CapyImg and create it

Input argument(s):

mode: mode of the image
dims: dimensions of the image

Output and side effect(s):

Return a CapyImg initialised to rgba opaque white

Exception(s):

May raise CapyExc_MallocFailed.

CapyImg* CapyImgLoadFromPath(char const* const path);

Load an image to a given path

Input argument(s):

path: the path to the image

Output and side effect(s):

Return a new image.

Exception(s):

May raise CapyExc_MallocFailed, CapyExc_UnsupportedFormat.

CapyImg* CapyImgClone(CapyImg const* const img);

Allocate memory and create a clone of an image

Input argument(s):

img: the image to clone

Output and side effect(s):

Return a clone of the image in argument

Exception(s):

May raise CapyExc_MallocFailed.

void CapyImgFree(CapyImg** const that);

Free the memory used by a CapyImg* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyImg to free

double CapyCm2Pixel(
  double const length,
  double const dpi);

Convert from cm to pixels given a dpi

Input argument(s):

length: the length in centimeter to convert
dpi: the dpi used to convert

Output and side effect(s):

Return the converted length.

double CapyPixel2Cm(
  double const length,
  double const dpi);

Convert from pixels to cm given a dpi

Input argument(s):

length: the length in pixels to convert
dpi: the dpi used to convert

Output and side effect(s):

Return the converted length.

2021-10-21
in LibCapy,
86 views