angry-pixel 2.0.18 → 2.0.20

package/lib/index.d.ts

@@ -372,6 +372,11 @@ declare class Rectangle {
  * @param min min value
  * @param max max value
  * @returns clamped value
+ * @example
+ * ```js
+ * clamp(10, 0, 5); // 5
+ * clamp(10, 0, 15); // 10
+ * ```
  */
 declare const clamp: (value: number, min: number, max: number) => number;
 /**
@@ -381,6 +386,10 @@ declare const clamp: (value: number, min: number, max: number) => number;
  * @param min min value
  * @param max max value
  * @returns the random int value
+ * @example
+ * ```js
+ * randomInt(0, 10); // 5
+ * ```
  */
 declare const randomInt: (min: number, max: number) => number;
 /**
@@ -390,6 +399,11 @@ declare const randomInt: (min: number, max: number) => number;
  * @param min min value
  * @param max max value
  * @returns the random float value
+ * @example
+ * ```js
+ * randomFloat(0, 10); // 5.23
+ * randomFloat(0, 10, 4); // 5.2345
+ * ```
  */
 declare const randomFloat: (min: number, max: number, decimals?: number) => number;
 /**
@@ -399,6 +413,10 @@ declare const randomFloat: (min: number, max: number, decimals?: number) => numb
  * @param value the value to round
  * @param decimals the number of decimals
  * @returns the rounded value
+ * @example
+ * ```js
+ * fixedRound(5.2345, 2); // 5.23
+ * ```
  */
 declare const fixedRound: (value: number, decimals: number) => number;
 /**
@@ -409,6 +427,11 @@ declare const fixedRound: (value: number, decimals: number) => number;
  * @param end the end value
  * @param steps the steps to move
  * @returns number range
+ * @example
+ * ```js
+ * range(0, 5); // [0, 1, 2, 3, 4, 5]
+ * range(0, 10, 2); // [0, 2, 4, 6, 8, 10]
+ * ```
  */
 declare const range: (start: number, end: number, steps?: number) => number[];
 /**
@@ -419,12 +442,23 @@ declare const range: (start: number, end: number, steps?: number) => number[];
  * @param min min value
  * @param max max value
  * @returns true if the number is between the min and the max, false instead
+ * @example
+ * ```js
+ * between(5, 0, 10); // true
+ * between(5, 0, 4); // false
+ * ```
  */
 declare const between: (value: number, min: number, max: number) => boolean;
 /**
  * Converts the given radians to degrees.
  * @param radians
  * @returns degrees
+ * @category Math
+ * @public
+ * @example
+ * ```js
+ * radiansToDegrees(Math.PI); // 180
+ * ```
  */
 declare const radiansToDegrees: (radians: number) => number;
 /**
@@ -433,8 +467,35 @@ declare const radiansToDegrees: (radians: number) => number;
  * @returns radians
  * @category Math
  * @public
+ * @example
+ * ```js
+ * degreesToRadians(180); // 3.141592653589793
+ * ```
  */
 declare const degreesToRadians: (degrees: number) => number;
+/**
+ * Convert RGB to HEX as string
+ * @param rgb
+ * @param prefix default is "#"
+ * @returns string
+ * @public
+ * @category Math
+ * @example
+ * ```js
+ * // default prefix "#"
+ * rgbToHex({ r: 255, g: 255, b: 255 }); // #ffffff
+ * ```
+ * @example
+ * ```js
+ * // no prefix
+ * rgbToHex({ r: 0, g: 255, b: 0 }, ""); // 00ff00
+ * ```
+ */
+declare const rgbToHex: ({ r, g, b }: {
+    r: number;
+    g: number;
+    b: number;
+}, prefix?: string) => string;
 
 /** @internal */
 interface Shape {
@@ -2586,6 +2647,7 @@ interface CameraOptions {
     layers: string[];
     zoom: number;
     depth: number;
+    debug: boolean;
 }
 /**
  * @public
@@ -3631,4 +3693,4 @@ declare const Symbols: {
     TimeManager: symbol;
 };
 
-export { Animation, type AnimationSlice, Animator, type AnimatorOptions, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, Children, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, Parent, Polygon, PolygonCollider, type PolygonColliderOptions, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, Scene, SceneManager, type SceneType, type SearchCriteria, type SearchResult, ShadowRenderer, type ShadowRendererOptions, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, Symbols, type System, type SystemGroup, SystemManager, type SystemType, TextOrientation, TextRenderer, type TextRendererOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, radiansToDegrees, randomFloat, randomInt, range };
+export { Animation, type AnimationSlice, Animator, type AnimatorOptions, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, Children, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, type DependencyName, type DependencyType, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, Parent, Polygon, PolygonCollider, type PolygonColliderOptions, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, Scene, SceneManager, type SceneType, type SearchCriteria, type SearchResult, ShadowRenderer, type ShadowRendererOptions, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, Symbols, type System, type SystemGroup, SystemManager, type SystemType, TextOrientation, TextRenderer, type TextRendererOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, radiansToDegrees, randomFloat, randomInt, range, rgbToHex };