Metadata-Version: 2.1
Name: cairo-rand-64x61
Version: 2.4.0
Summary: Pseudorandom and procedural generation library using 64.61 fixed point
Author-email: "Unstoppable Games, Inc." <info@unstoppablegames.io>
License: MIT License
        
        Copyright (c) 2022 Unstoppable Games, Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/influenceth/cairo-rand-64x61
Project-URL: Bug Tracker, https://github.com/influenceth/cairo-rand-64x61/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

[![PyPI version](https://badge.fury.io/py/cairo_rand_64x61.svg)](https://badge.fury.io/py/cairo_rand_64x61)

# Cairo Rand 64x61

A psuedrandom and procedural generation library using 64.61 fixed point math for Cairo

## Usage ##
Install with `pip install cairo_rand_64x61` and import and use with `from cairo_rand_64x61.simplex import Simplex`.

## Signed 64.61 Fixed Point Numbers ##
This library is heavily dependend on 64.61 bit fixed point numbers. See https://github.com/influenceth/cairo-math-64x61 for more information.

## Simplex Library ##
`Simplex` includes an implementation of a three-dimensional simplex noise based on the GLSL implementation found here: https://github.com/ashima/webgl-noise/blob/master/src/noise3D.glsl. It is tested against output of the GLSL library. Keep in mind that in many cases the GLSL implementation will be run on GPUs using medium precision which will lead to errors with large input values for `x, y, z`. This cairo library does *NOT* attempt to mimic this error (this error will also disappear if using high precision on GPU).

## Extensibility ##
This library strives to adhere to the OpenZeppelin extensibility pattern: https://docs.openzeppelin.com/contracts-cairo/0.2.1/extensibility#libraries
