McRogueFace/deps_windows/libtcod-1.23.1-x86_64-msvc/include/libtcod/noise.h

163 lines
5.6 KiB
C

/* BSD 3-Clause License
*
* Copyright © 2008-2022, Jice and the libtcod contributors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _TCOD_PERLIN_H
#define _TCOD_PERLIN_H
#include "config.h"
#include "mersenne_types.h"
#include "noise_defaults.h"
typedef enum {
TCOD_NOISE_PERLIN = 1,
TCOD_NOISE_SIMPLEX = 2,
TCOD_NOISE_WAVELET = 4,
TCOD_NOISE_DEFAULT = 0
} TCOD_noise_type_t;
typedef struct TCOD_Noise {
int ndim;
/** Randomized map of indexes into buffer */
unsigned char map[256];
/** Random 256 x ndim buffer */
float buffer[256][TCOD_NOISE_MAX_DIMENSIONS];
/* fractal stuff */
float H;
float lacunarity;
float exponent[TCOD_NOISE_MAX_OCTAVES];
float* __restrict waveletTileData;
TCOD_Random* rand;
/* noise type */
TCOD_noise_type_t noise_type;
} TCOD_Noise;
typedef TCOD_Noise* TCOD_noise_t;
#ifdef __cplusplus
extern "C" {
#endif
/* create a new noise object */
TCOD_NODISCARD
TCOD_PUBLIC TCOD_Noise* TCOD_noise_new(int dimensions, float hurst, float lacunarity, TCOD_Random* random);
/* simplified API */
TCOD_PUBLIC void TCOD_noise_set_type(TCOD_Noise* __restrict noise, TCOD_noise_type_t type);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get_ex(TCOD_Noise* __restrict noise, const float* __restrict f, TCOD_noise_type_t type);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get_fbm_ex(
TCOD_Noise* __restrict noise, const float* __restrict f, float octaves, TCOD_noise_type_t type);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get_turbulence_ex(
TCOD_Noise* __restrict noise, const float* __restrict f, float octaves, TCOD_noise_type_t type);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get(TCOD_Noise* __restrict noise, const float* __restrict f);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get_fbm(TCOD_Noise* __restrict noise, const float* __restrict f, float octaves);
TCOD_NODISCARD
TCOD_PUBLIC float TCOD_noise_get_turbulence(TCOD_Noise* __restrict noise, const float* __restrict f, float octaves);
/* delete the noise object */
TCOD_PUBLIC void TCOD_noise_delete(TCOD_Noise* __restrict noise);
/**
Generate noise as a vectorized operation.
`noise` is the TCOD_Noise object to be used. Its dimensions will
determine how many input arrays are required.
`type` is which noise generator should be used.
Can be `TCOD_NOISE_DEFAULT` to use the type set by the TCOD_Noise object.
`n` is the length of the input and output arrays.
`x[n]`, `y[n]`, `z[n]`, `w[n]` are the input coordinates for the noise
generator. For a 2D generator you'd provide the `x[n]` and `y[n]` arrays
and leave the remaining arrays as NULL.
`out[n]` is the output array, which will receive the noise values.
\rst
.. versionadded:: 1.16
\endrst
*/
TCOD_PUBLIC void TCOD_noise_get_vectorized(
TCOD_Noise* __restrict noise,
TCOD_noise_type_t type,
int n,
float* __restrict x,
float* __restrict y,
float* __restrict z,
float* __restrict w,
float* __restrict out);
/**
Generate noise as a vectorized operation with fractional Brownian motion.
`octaves` are the number of samples to take.
The remaining parameters are the same as `TCOD_noise_get_vectorized`.
\rst
.. versionadded:: 1.16
\endrst
*/
TCOD_PUBLIC void TCOD_noise_get_fbm_vectorized(
TCOD_Noise* __restrict noise,
TCOD_noise_type_t type,
float octaves,
int n,
float* __restrict x,
float* __restrict y,
float* __restrict z,
float* __restrict w,
float* __restrict out);
/**
Generate noise as a vectorized operation with turbulence.
`octaves` are the number of samples to take.
The remaining parameters are the same as `TCOD_noise_get_vectorized`.
\rst
.. versionadded:: 1.16
\endrst
*/
TCOD_PUBLIC void TCOD_noise_get_turbulence_vectorized(
TCOD_Noise* __restrict noise,
TCOD_noise_type_t type,
float octaves,
int n,
float* __restrict x,
float* __restrict y,
float* __restrict z,
float* __restrict w,
float* __restrict out);
#ifdef __cplusplus
}
#endif
#endif