.. _program_listing_file_libtcod_noise.hpp:

Program Listing for File noise.hpp
==================================

|exhale_lsh| :ref:`Return to documentation for file <file_libtcod_noise.hpp>` (``libtcod/noise.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /* BSD 3-Clause License
    *
    * Copyright © 2008-2026, 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.
    */
   #pragma once
   #ifndef TCOD_PERLIN_HPP_
   #define TCOD_PERLIN_HPP_
   
   #include <utility>
   
   #include "mersenne.hpp"
   #include "noise.h"
   #include "noise_defaults.h"
   // clang-format off
   class TCODLIB_API TCODNoise {
     public :
       TCODNoise(int dimensions, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       TCODNoise(int dimensions, TCODRandom *random, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       TCODNoise(int dimensions, float hurst, float lacunarity, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       TCODNoise(int dimensions, float hurst, float lacunarity, TCODRandom *random, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
   
       TCODNoise(const TCODNoise&) = delete;
       TCODNoise& operator=(const TCODNoise&) = delete;
       TCODNoise(TCODNoise&& rhs) noexcept { std::swap(data, rhs.data); };
       TCODNoise& operator=(TCODNoise&& rhs) noexcept {
         std::swap(data, rhs.data);
         return *this;
       };
   
       virtual ~TCODNoise();
   
       void setType (TCOD_noise_type_t type);
       float get(float *f, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       float get(const float *f, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       float getFbm(float *f, float octaves, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       float getFbm(const float *f, float octaves, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       float getTurbulence(float *f, float octaves, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
       float getTurbulence(const float *f, float octaves, TCOD_noise_type_t type = TCOD_NOISE_DEFAULT);
   
     protected :
       friend class TCODLIB_API TCODHeightMap;
       TCOD_noise_t data{};
   };
   
   #endif // TCOD_PERLIN_HPP_