libtcod
Loading...
Searching...
No Matches
bresenham.h
Go to the documentation of this file.
1/* BSD 3-Clause License
2 *
3 * Copyright © 2008-2026, Jice and the libtcod contributors.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
34#pragma once
35#ifndef TCOD_BRESENHAM_H_
36#define TCOD_BRESENHAM_H_
37
38#include "portability.h"
39
42#ifdef __cplusplus
43extern "C" {
44#endif
56typedef bool (*TCOD_line_listener_t)(int x, int y);
73TCODLIB_API TCOD_DEPRECATED("This function is not reentrant. Use TCOD_line_init_mt instead.") void TCOD_line_init(
74 int xFrom, int yFrom, int xTo, int yTo);
93TCODLIB_API TCOD_DEPRECATED("This function is not reentrant.") bool TCOD_line_step(
94 int* __restrict xCur, int* __restrict yCur);
110TCODLIB_API bool TCOD_line(int xFrom, int yFrom, int xTo, int yTo, TCOD_line_listener_t listener);
114typedef struct {
115 int stepx;
116 int stepy;
117 int e;
118 int deltax;
119 int deltay;
120 int origx;
121 int origy;
122 int destx;
123 int desty;
124} TCOD_bresenham_data_t;
125
137TCODLIB_API void TCOD_line_init_mt(int xFrom, int yFrom, int xTo, int yTo, TCOD_bresenham_data_t* data);
149TCODLIB_API bool TCOD_line_step_mt(int* __restrict xCur, int* __restrict yCur, TCOD_bresenham_data_t* __restrict data);
167TCOD_DEPRECATED("Use TCOD_line instead.")
168TCODLIB_API bool TCOD_line_mt(
169 int xFrom, int yFrom, int xTo, int yTo, TCOD_line_listener_t listener, TCOD_bresenham_data_t* data);
170
171#ifdef __cplusplus
172} // extern "C"
173#endif // __cplusplus
175#endif // TCOD_BRESENHAM_H_
TCOD_line_step
bool TCOD_line_step(int *xCur, int *yCur)
Advance to the next point in a line, returns true once the line has ended.
TCOD_line_listener_t
bool(* TCOD_line_listener_t)(int x, int y)
A callback to be passed to TCOD_line.
Definition bresenham.h:56
TCOD_line_init
void TCOD_line_init(int xFrom, int yFrom, int xTo, int yTo)
Initialize a line using a global state.
TCOD_line
bool TCOD_line(int xFrom, int yFrom, int xTo, int yTo, TCOD_line_listener_t listener)
Iterate over a line using a callback.
TCOD_line_init_mt
void TCOD_line_init_mt(int xFrom, int yFrom, int xTo, int yTo, TCOD_bresenham_data_t *data)
Initialize a TCOD_bresenham_data_t struct.
TCOD_line_mt
bool TCOD_line_mt(int xFrom, int yFrom, int xTo, int yTo, TCOD_line_listener_t listener, TCOD_bresenham_data_t *data)
Iterate over a line using a callback.
TCOD_line_step_mt
bool TCOD_line_step_mt(int *xCur, int *yCur, TCOD_bresenham_data_t *data)
Get the next point on a line, returns true once the line has ended.
portability.h
Miscellaneous tools needed across platforms.
TCOD_bresenham_data_t
A struct used for computing a bresenham line.
Definition bresenham.h:114