Skip to content

Commit 21ad151

Browse files
authored
Merge pull request phaserjs#2593 from monagames/ts-color-definitions
Improved typescript definitions
2 parents 8c5cea0 + d566126 commit 21ad151

1 file changed

Lines changed: 33 additions & 17 deletions

File tree

typescript/phaser.d.ts

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -343,8 +343,8 @@ declare module Phaser {
343343
move(x: number, y: number, wrap?: boolean): Phaser.BitmapData;
344344
moveH(distance: number, wrap?: boolean): Phaser.BitmapData;
345345
moveV(distance: number, wrap?: boolean): Phaser.BitmapData;
346-
processPixel(callback: Function, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
347-
processPixelRGB(callback: Function, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
346+
processPixel(callback: (color: number, x: number, y: number) => void, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
347+
processPixelRGB(callback: (color: ColorComponents, x: number, y: number) => void, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
348348
rect(x: number, y: number, width: number, height: number, fillStyle?: string): Phaser.BitmapData;
349349
render(): Phaser.BitmapData;
350350
replaceRGB(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number, region?: Phaser.Rectangle): Phaser.BitmapData;
@@ -734,8 +734,8 @@ declare module Phaser {
734734
class Color {
735735

736736
static componentToHex(color: number): string;
737-
static createColor(r?: number, g?: number, b?: number, a?: number, h?: number, s?: number, l?: number, v?: number): any;
738-
static fromRGBA(rgba: number, out?: any): any;
737+
static createColor(r?: number, g?: number, b?: number, a?: number, h?: number, s?: number, l?: number, v?: number): ColorComponents;
738+
static fromRGBA(rgba: number, out?: ColorComponents): ColorComponents;
739739
static getAlpha(color: number): number;
740740
static getAlphaFloat(color: number): number;
741741
static getBlue(color: number): number;
@@ -744,27 +744,27 @@ declare module Phaser {
744744
static getGreen(color: number): number;
745745
static getRandomColor(min?: number, max?: number, alpha?: number): number;
746746
static getRed(color: number): number;
747-
static getRGB(color: number): any;
748-
static getWebRGB(color: any): string;
747+
static getRGB(color: number): RGBColor;
748+
static getWebRGB(color: number | RGBColor): string;
749749
static hexToRGB(h: string): number;
750-
static hexToColor(hex: string, out?: any): any;
751-
static HSLtoRGB(h: number, s: number, l: number, out?: any): any;
752-
static HSLColorWheel(s?: number, l?: number): any[];
753-
static HSVtoRGB(h: number, s: number, v: number, out?: any): any;
754-
static HSVColorWheel(s?: number, v?: number): any[];
750+
static hexToColor(hex: string, out?: ColorComponents): ColorComponents;
751+
static HSLtoRGB(h: number, s: number, l: number, out?: ColorComponents): ColorComponents;
752+
static HSLColorWheel(s?: number, l?: number): ColorComponents[];
753+
static HSVtoRGB(h: number, s: number, v: number, out?: ColorComponents): ColorComponents;
754+
static HSVColorWheel(s?: number, v?: number): ColorComponents[];
755755
static hueToColor(p: number, q: number, t: number): number;
756756
static interpolateColor(color1: number, color2: number, steps: number, currentStep: number, alpha: number): number;
757757
static interpolateColorWithRGB(color: number, r: number, g: number, b: number, steps: number, currentStep: number): number;
758758
static interpolateRGB(r1: number, g1: number, b1: number, r2: number, g2: number, b2: number, steps: number, currentStep: number): number;
759759
static packPixel(r: number, g: number, b: number, a: number): number;
760-
static RGBtoHSL(r: number, g: number, b: number, out?: any): any;
761-
static RGBtoHSV(r: number, g: number, b: number, out?: any): any;
760+
static RGBtoHSL(r: number, g: number, b: number, out?: ColorComponents): ColorComponents;
761+
static RGBtoHSV(r: number, g: number, b: number, out?: ColorComponents): ColorComponents;
762762
static RGBtoString(r: number, g: number, b: number, a?: number, prefix?: string): string;
763763
static toRGBA(r: number, g: number, b: number, a: number): number;
764-
static unpackPixel(rgba: number, out?: any, hsl?: boolean, hsv?: boolean): any;
765-
static updateColor(out: any): number;
766-
static valueToColor(value: string, out?: any): { r: number; g: number; b: number; a: number; };
767-
static webToColor(web: string, out?: any): { r: number; g: number; b: number; a: number; };
764+
static unpackPixel(rgba: number, out?: ColorComponents, hsl?: boolean, hsv?: boolean): ColorComponents;
765+
static updateColor(out: ColorComponents): ColorComponents;
766+
static valueToColor(value: string, out?: ColorComponents): ColorComponents;
767+
static webToColor(web: string, out?: ColorComponents): ColorComponents;
768768
static blendNormal(a: number): number;
769769
static blendLighten(a: number, b: number): number;
770770
static blendDarken(a: number, b: number): number;
@@ -793,6 +793,22 @@ declare module Phaser {
793793

794794
}
795795

796+
interface RGBColor {
797+
r: number;
798+
g: number;
799+
b: number;
800+
a: number;
801+
}
802+
interface ColorComponents extends RGBColor {
803+
h: number;
804+
s: number;
805+
v: number;
806+
l: number;
807+
color: number;
808+
color32: number;
809+
rgba: string;
810+
}
811+
796812
class Create {
797813

798814
constructor(game: Phaser.Game);

0 commit comments

Comments
 (0)