libsxbp/initialise_8h_source.html

 /*
  * This source file forms part of libsxbp, a library which generates
  * experimental 2D spiral-like shapes based on input binary data.
  */

 #ifndef SAXBOPHONE_SAXBOSPIRAL_INITIALISE_H
 #define SAXBOPHONE_SAXBOSPIRAL_INITIALISE_H

 #include "saxbospiral.h"


 #ifdef __cplusplus
 extern "C"{
 #endif

 sxbp_direction_t sxbp_change_direction(
     sxbp_direction_t current, sxbp_rotation_t turn
 );

 sxbp_spiral_t sxbp_blank_spiral(void);

 sxbp_status_t sxbp_init_spiral(sxbp_buffer_t buffer, sxbp_spiral_t* spiral);

 #ifdef __cplusplus
 } // extern "C"
 #endif

 // end of header file
 #endif
sxbp_direction_t
uint8_t sxbp_direction_t
Type for representing one of the cartesian directions.
Definition: saxbospiral.h:101

saxbospiral.h
This compilation unit provides most of the data types used by the library, as well as defining some l...

sxbp_buffer_t
A simple buffer type for storing arrays of bytes.
Definition: saxbospiral.h:236

sxbp_init_spiral
sxbp_status_t sxbp_init_spiral(sxbp_buffer_t buffer, sxbp_spiral_t *spiral)
Builds a partially-complete spiral from binary input data stored in a buffer.
Definition: initialise.c:33

sxbp_spiral_t
Struct type representing a Spiral figure, in any state of completion.
Definition: saxbospiral.h:189

sxbp_rotation_t
int8_t sxbp_rotation_t
Type for representing a rotational direction.
Definition: saxbospiral.h:113

sxbp_blank_spiral
sxbp_spiral_t sxbp_blank_spiral(void)
Builds a blank spiral struct.
Definition: initialise.c:29

sxbp_status_t
sxbp_status_t
Represents the success or failure status of an executed function.
Definition: saxbospiral.h:87

sxbp_change_direction
sxbp_direction_t sxbp_change_direction(sxbp_direction_t current, sxbp_rotation_t turn)
Gets the direction which is clockwise or anti-clockwise to the current direction. ...
Definition: initialise.c:23