Baillehache Pascal's personal website

LibCapy - bnoise

B-Noise generator class.

Macros:

#define CAPY_BNOISE_H

#define CAPY_BNOISE_NB_DIM_IN 2

Dimensions of noise: 2D->1D

#define CAPY_BNOISE_NB_DIM_OUT 1

Enumerations:

None.

Typedefs:

typedef uint8_t CapyBNoiseOrder_t;

Type of the order of a BNoise

Struct CapyBNoise :

Struct CapyBNoise's properties:

  CapyNoiseDef;

Inherits CapyNoise

  CapyBNoiseOrder_t order;

Order of the noise

  CapyPad(CapyBNoiseOrder_t, order);

  size_t dim;

Dimension of the grid (square) in number of vertices

  double fDim;

Cast to float of the dimension of the grid

  double* map;

Noise data

  double* curve[CAPY_BNOISE_NB_DIM_IN][CAPY_BNOISE_NB_DIM_IN];

Struct CapyBNoise's methods:

  void (*destructCapyNoise)(void);

Destructor

Functions:

CapyBNoise CapyBNoiseCreate(
  CapyBNoiseOrder_t const order,
   CapyRandomSeed_t const seed);

Create a CapyBNoise

Input argument(s):

order: order of the noise
seed: seed of the noise

Output and side effect(s):

Return a CapyBNoise

CapyBNoise* CapyBNoiseAlloc(
  CapyBNoiseOrder_t const order,
   CapyRandomSeed_t const seed);

Allocate memory for a new CapyBNoise and create it

Input argument(s):

order: order of the noise
seed: seed of the noise

Output and side effect(s):

Return a CapyBNoise

Exception(s):

May raise CapyExc_MallocFailed.

void CapyBNoiseFree(CapyBNoise** const that);

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

Input argument(s):

that: a pointer to the CapyBNoise to free

2023-03-26
in LibCapy,
12 views