Baillehache Pascal's personal website

LibCapy - ppmFormat

Class to manipulate file in PPM format

Macros:

#define CAPY_PPMFORMAT_H

Enumerations:

typedef enum CapyPpmType {
  capyPpmType_p3,
  capyPpmType_p6,
  capyPpmType_nb,
} CapyPpmType;

PPM types

Typedefs:

None.

Struct CapyPpmFormat :

Struct CapyPpmFormat's properties:

  CapyFileFormatDef;

Parent class

  CapyPpmType ppmType;

Type (default: P3)

  CapyPad(CapyPpmType, ppmType);

  uint16_t maxVal;

Max value (in [1, 65535], default: 255)

  CapyPad(uint16_t, maxVal);

Struct CapyPpmFormat's methods:

  void (*destructCapyFileFormat)(void);

Destructor

Functions:

CapyPpmFormat CapyPpmFormatCreate(void);

Create a CapyPpmFormat

Output and side effect(s):

Return a CapyPpmFormat

CapyPpmFormat* CapyPpmFormatAlloc(void);

Allocate memory for a new CapyPpmFormat and create it

Output and side effect(s):

Return a CapyPpmFormat

Exception(s):

May raise CapyExc_MallocFailed.

void CapyPpmFormatDestruct(CapyPpmFormat* const that);

Free the memory used by a CapyPpmFormat

Input argument(s):

that: the CapyPpmFormat to free

void CapyPpmFormatFree(CapyPpmFormat** const that);

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

Input argument(s):

that: a pointer to the CapyPpmFormat to free

2026-03-29
in LibCapy,
6 views