Banjo API 1.1.0-alpha
Low-level C99 game development API
Loading...
Searching...
No Matches
maze_builder.h
Go to the documentation of this file.
1
90#ifndef BJ_MAZE_BUILDER_H
91#define BJ_MAZE_BUILDER_H
92#include <banjo/api.h>
93#include <banjo/maze.h>
94#include <banjo/random.h>
95
96struct bj_maze_builder;
97
117
134struct bj_maze_marks;
135
145BANJO_EXPORT struct bj_maze_marks* bj_create_maze_marks(
146 const struct bj_maze* maze,
147 struct bj_error** error
148);
149
156 struct bj_maze_marks* marks
157);
158
165 struct bj_maze_marks* marks
166);
167
180 const struct bj_maze_marks* marks,
181 uint32_t cell
182);
183
200 struct bj_maze_marks* marks,
201 uint32_t cell,
202 uint8_t bits
203);
204
215 struct bj_maze_marks* marks,
216 uint32_t cell,
217 uint8_t bits
218);
219
228 struct bj_maze* maze;
230 void* rng_state;
231 void* data;
232 struct bj_maze_marks* marks;
233};
234
257typedef void* (*bj_maze_setup_fn)(
258 const struct bj_maze_build_context* context,
259 struct bj_error** error
260);
261
293 struct bj_maze_build_context* context
294);
295
307typedef void (*bj_maze_teardown_fn)(
308 void* data
309);
310
337
355 void
356);
357
374 void
375);
376
391 void
392);
393
414 void
415);
416
443 void
444);
445
474 void
475);
476
511 struct bj_maze* maze,
512 struct bj_maze_algorithm algorithm,
513 struct bj_maze_marks* marks,
514 bj_random_u32_fn next,
515 void* rng_state,
516 struct bj_error** error
517);
518
528 struct bj_maze_builder* builder
529);
530
546 struct bj_maze_builder* builder
547);
548
555 struct bj_maze_builder* builder
556);
557
584 struct bj_maze_builder* builder,
585 struct bj_error** error
586);
587
595 const struct bj_maze_builder* builder
596);
597
600
601#endif
General-purpose definitions for Banjo API.
bj_audio_play_note_data data
Definition audio_pcm.c:104
struct bj_maze bj_maze
Definition api.h:363
struct bj_error bj_error
Definition api.h:348
#define BANJO_EXPORT
Definition api.h:179
uint32_t bj_bool
Boolean type used throughout the Banjo API.
Definition api.h:264
struct bj_maze_builder bj_maze_builder
Definition api.h:364
bj_maze_step_fn step
Does one step. Required.
bj_maze_teardown_fn teardown
Releases the state, or NULL.
void * rng_state
Opaque state to pass to next.
struct bj_maze * maze
The maze being carved. Never NULL.
bj_random_u32_fn next
RNG callback. Never NULL.
bj_maze_setup_fn setup
Prepares the state, or NULL.
void * data
Algorithm state. See bj_maze_step_fn.
struct bj_maze_marks * marks
Where to record progress, or NULL.
struct bj_maze_algorithm bj_maze_algorithm_wilson(void)
Wilson's algorithm.
bj_maze_mark
What an algorithm can record about a cell as it works.
bj_bool(* bj_maze_step_fn)(struct bj_maze_build_context *context)
One step of a maze generation algorithm.
void bj_destroy_maze_builder(struct bj_maze_builder *builder)
Destroy a builder and release the algorithm state it accumulated.
void bj_mark_maze_cell(struct bj_maze_marks *marks, uint32_t cell, uint8_t bits)
Add marks to a cell.
bj_bool bj_step_maze_builder(struct bj_maze_builder *builder)
Perform one step of generation.
void *(* bj_maze_setup_fn)(const struct bj_maze_build_context *context, struct bj_error **error)
Prepares whatever an algorithm needs to remember between steps.
bj_bool bj_maze_builder_is_complete(const struct bj_maze_builder *builder)
Tell whether generation has completed.
struct bj_maze_algorithm bj_maze_algorithm_backtracker(void)
The backtracker, known in the literature as the recursive backtracker.
bj_bool bj_reset_maze_builder(struct bj_maze_builder *builder, struct bj_error **error)
Start the algorithm over.
void bj_clear_maze_marks(struct bj_maze_marks *marks)
Take every mark off every cell.
struct bj_maze_algorithm bj_maze_algorithm_sidewinder(void)
The sidewinder algorithm.
struct bj_maze_algorithm bj_maze_algorithm_hunt_and_kill(void)
The hunt-and-kill algorithm.
void bj_run_maze_builder(struct bj_maze_builder *builder)
Step the builder until generation completes.
struct bj_maze_marks * bj_create_maze_marks(const struct bj_maze *maze, struct bj_error **error)
Allocate marks for every cell of maze, all clear.
void bj_unmark_maze_cell(struct bj_maze_marks *marks, uint32_t cell, uint8_t bits)
Take marks off a cell.
uint8_t bj_maze_cell_marks(const struct bj_maze_marks *marks, uint32_t cell)
Read what is recorded about a cell.
struct bj_maze_algorithm bj_maze_algorithm_btree(void)
The binary tree algorithm.
bj_bool bj_maze_builder_completed(const struct bj_maze_builder *builder)
struct bj_maze_builder * bj_create_maze_builder(struct bj_maze *maze, struct bj_maze_algorithm algorithm, struct bj_maze_marks *marks, bj_random_u32_fn next, void *rng_state, struct bj_error **error)
Create a builder that carves maze with algorithm.
void bj_destroy_maze_marks(struct bj_maze_marks *marks)
Release marks.
void(* bj_maze_teardown_fn)(void *data)
Releases what bj_maze_setup_fn produced.
struct bj_maze_algorithm bj_maze_algorithm_aldous_broder(void)
The Aldous-Broder algorithm.
@ BJ_MAZE_MARK_PATH
On the route currently under consideration.
@ BJ_MAZE_MARK_USER
First bit an algorithm may use as it likes.
@ BJ_MAZE_MARK_VISITED
The algorithm is done with this cell.
@ BJ_MAZE_MARK_HEAD
Where the algorithm is working now.
A maze generation algorithm.
Everything a build step is given to work with.
uint32_t(* bj_random_u32_fn)(void *state)
RNG callback type for generator-agnostic distributions.
Definition random.h:223
Header file for Maze representation.
Pseudo-random number generation API.