phaser/docs/Color.js.html at dev · feiss/phaser

History

836 lines (642 loc) · 22.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

<!DOCTYPE html>

<head>

<title>Phaser Source: utils/Color.js</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<body>

<a class="brand" href="index.html">Phaser</a>

<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b

class="caret"></b></a>

<li>

<a href="Phaser.html">Phaser</a>

</li>

</ul>

</li>

<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b

class="caret"></b></a>

<li>

<a href="Phaser.Animation.html">Animation</a>

</li>

<li>

<a href="Phaser.AnimationManager.html">AnimationManager</a>

</li>

<li>

<a href="Phaser.AnimationParser.html">AnimationParser</a>

</li>

<li>

<a href="Phaser.BitmapData.html">BitmapData</a>

</li>

<li>

<a href="Phaser.BitmapText.html">BitmapText</a>

</li>

<li>

<a href="Phaser.Button.html">Button</a>

</li>

<li>

<a href="Phaser.Cache.html">Cache</a>

</li>

<li>

<a href="Phaser.Camera.html">Camera</a>

</li>

<li>

<a href="Phaser.Canvas.html">Canvas</a>

</li>

<li>

<a href="Phaser.Circle.html">Circle</a>

</li>

<li>

<a href="Phaser.Color.html">Color</a>

</li>

<li>

<a href="Phaser.Device.html">Device</a>

</li>

<li>

<a href="Phaser.Easing.html">Easing</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Easing.Bounce.html">Bounce</a>

</li>

<li>

<a href="Phaser.Easing.Circular.html">Circular</a>

</li>

<li>

<a href="Phaser.Easing.Cubic.html">Cubic</a>

</li>

<li>

<a href="Phaser.Easing.Elastic.html">Elastic</a>

</li>

<li>

<a href="Phaser.Easing.Exponential.html">Exponential</a>

</li>

<li>

<a href="Phaser.Easing.Linear.html">Linear</a>

</li>

<li>

<a href="Phaser.Easing.Quadratic.html">Quadratic</a>

</li>

<li>

<a href="Phaser.Easing.Quartic.html">Quartic</a>

</li>

<li>

<a href="Phaser.Easing.Quintic.html">Quintic</a>

</li>

<li>

<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>

</li>

<li>

<a href="Phaser.Events.html">Events</a>

</li>

<li>

<a href="Phaser.Filter.html">Filter</a>

</li>

<li>

<a href="Phaser.Frame.html">Frame</a>

</li>

<li>

<a href="Phaser.FrameData.html">FrameData</a>

</li>

<li>

</li>

<li>

<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>

</li>

<li>

<a href="Phaser.Graphics.html">Graphics</a>

</li>

<li>

<a href="Phaser.Group.html">Group</a>

</li>

<li>

<a href="Phaser.Input.html">Input</a>

</li>

<li>

<a href="Phaser.InputHandler.html">InputHandler</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Keyboard.html">Keyboard</a>

</li>

<li>

<a href="Phaser.LinkedList.html">LinkedList</a>

</li>

<li>

<a href="Phaser.Loader.html">Loader</a>

</li>

<li>

<a href="Phaser.LoaderParser.html">LoaderParser</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Mouse.html">Mouse</a>

</li>

<li>

<a href="Phaser.MSPointer.html">MSPointer</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Particles.html">Particles</a>

</li>

<li>

<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>

</li>

<li>

<a href="Phaser.Physics.html">Physics</a>

</li>

<li>

<a href="Phaser.Physics.Arcade.html">Arcade</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Plugin.html">Plugin</a>

</li>

<li>

<a href="Phaser.PluginManager.html">PluginManager</a>

</li>

<li>

<a href="Phaser.Point.html">Point</a>

</li>

<li>

<a href="Phaser.Pointer.html">Pointer</a>

</li>

<li>

<a href="Phaser.Polygon.html">Polygon</a>

</li>

<li>

<a href="Phaser.QuadTree.html">QuadTree</a>

</li>

<li>

<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>

</li>

<li>

<a href="Phaser.Rectangle.html">Rectangle</a>

</li>

<li>

<a href="Phaser.RenderTexture.html">RenderTexture</a>

</li>

<li>

<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>

</li>

<li>

<a href="Phaser.Signal.html">Signal</a>

</li>

<li>

<a href="Phaser.Sound.html">Sound</a>

</li>

<li>

<a href="Phaser.SoundManager.html">SoundManager</a>

</li>

<li>

<a href="Phaser.Sprite.html">Sprite</a>

</li>

<li>

<a href="Phaser.Stage.html">Stage</a>

</li>

<li>

<a href="Phaser.StageScaleMode.html">StageScaleMode</a>

</li>

<li>

<a href="Phaser.State.html">State</a>

</li>

<li>

<a href="Phaser.StateManager.html">StateManager</a>

</li>

<li>

</li>

<li>

</li>

<li>

<a href="Phaser.Tilemap.html">Tilemap</a>

</li>

<li>

<a href="Phaser.TilemapLayer.html">TilemapLayer</a>

</li>

<li>

<a href="Phaser.TilemapParser.html">TilemapParser</a>

</li>

<li>

<a href="Phaser.Tileset.html">Tileset</a>

</li>

<li>

<a href="Phaser.TileSprite.html">TileSprite</a>

</li>

<li>

</li>

<li>

<a href="Phaser.Timer.html">Timer</a>

</li>

<li>

<a href="Phaser.Touch.html">Touch</a>

</li>

<li>

<a href="Phaser.Tween.html">Tween</a>

</li>

<li>

<a href="Phaser.TweenManager.html">TweenManager</a>

</li>

<li>

<a href="Phaser.Utils.html">Utils</a>

</li>

<li>

<a href="Phaser.Utils.Debug.html">Debug</a>

</li>

<li>

<a href="Phaser.World.html">World</a>

</li>

<li>

<a href="SignalBinding.html">SignalBinding</a>

</li>

</ul>

</li>

<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b

class="caret"></b></a>

<li>

<a href="global.html#bottom">bottom</a>

</li>

<li>

<a href="global.html#HEXtoRGB">HEXtoRGB</a>

</li>

<li>

<a href="global.html#render">render</a>

</li>

<li>

<a href="global.html#renderXY">renderXY</a>

</li>

<li>

<a href="global.html#right">right</a>

</li>

</ul>

</li>

</ul>

</div>

<h1 class="page-title">Source: utils/Color.js</h1>

<pre class="sunlight-highlight-javascript linenums">/**

* @author Richard Davey <[email protected]>

* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}

/**

* A collection of methods useful for manipulating and comparing colors.

* @class Phaser.Color

Phaser.Color = {

/**

* Given an alpha and 3 color values this will return an integer representation of it.

* @method Phaser.Color.getColor32

* @static

* @param {number} alpha - The Alpha value (between 0 and 255).

* @param {number} red - The Red channel value (between 0 and 255).

* @param {number} green - The Green channel value (between 0 and 255).

* @param {number} blue - The Blue channel value (between 0 and 255).

* @returns {number} A native color value integer (format: 0xAARRGGBB).

getColor32: function (alpha, red, green, blue) {

return alpha << 24 | red << 16 | green << 8 | blue;

/**

* Given 3 color values this will return an integer representation of it.

* @method Phaser.Color.getColor

* @static

* @param {number} red - The Red channel value (between 0 and 255).

* @param {number} green - The Green channel value (between 0 and 255).

* @param {number} blue - The Blue channel value (between 0 and 255).

* @returns {number} A native color value integer (format: 0xRRGGBB).

getColor: function (red, green, blue) {

return red << 16 | green << 8 | blue;

/**

* Converts the given hex string into an integer color value.

* @method Phaser.Color.hexToRGB

* @static

* @param {string} h - The string hex color to convert.

* @returns {number} The rgb color value.

hexToRGB: function (h) {

var hex16 = (h.charAt(0) == "#") ? h.substring(1, 7) : h;

if (hex16.length==3)

{

hex16 = hex16.charAt(0) + hex16.charAt(0) + hex16.charAt(1) + hex16.charAt(1) + hex16.charAt(2) + hex16.charAt(2);

}

var red = parseInt(hex16.substring(0, 2), 16);

var green = parseInt(hex16.substring(2, 4), 16);

var blue = parseInt(hex16.substring(4, 6), 16);

return red << 16 | green << 8 | blue;

/**

* Returns a string containing handy information about the given color including string hex value,

* RGB format information and HSL information. Each section starts on a newline, 3 lines in total.

* @method Phaser.Color.getColorInfo

* @static

* @param {number} color - A color value in the format 0xAARRGGBB.

* @returns {string} String containing the 3 lines of information.

getColorInfo: function (color) {

var argb = Phaser.Color.getRGB(color);

var hsl = Phaser.Color.RGBtoHSV(color);

// Hex format

var result = Phaser.Color.RGBtoHexstring(color) + "\n";

// RGB format

result = result.concat("Alpha: " + argb.alpha + " Red: " + argb.red + " Green: " + argb.green + " Blue: " + argb.blue) + "\n";

// HSL info

result = result.concat("Hue: " + hsl.hue + " Saturation: " + hsl.saturation + " Lightnes: " + hsl.lightness);

return result;

/**

* Return a string representation of the color in the format 0xAARRGGBB.

* @method Phaser.Color.RGBtoHexstring

* @static

* @param {number} color - The color to get the string representation for

* @returns {string} A string of length 10 characters in the format 0xAARRGGBB

RGBtoHexstring: function (color) {

var argb = Phaser.Color.getRGB(color);

return "0x" + Phaser.Color.colorToHexstring(argb.alpha) + Phaser.Color.colorToHexstring(argb.red) + Phaser.Color.colorToHexstring(argb.green) + Phaser.Color.colorToHexstring(argb.blue);

/**

* Return a string representation of the color in the format #RRGGBB.

* @method Phaser.Color.RGBtoWebstring

* @static

* @param {number} color - The color to get the string representation for.

* @returns {string} A string of length 10 characters in the format 0xAARRGGBB.

RGBtoWebstring: function (color) {

var argb = Phaser.Color.getRGB(color);

return "#" + Phaser.Color.colorToHexstring(argb.red) + Phaser.Color.colorToHexstring(argb.green) + Phaser.Color.colorToHexstring(argb.blue);

/**

* Return a string containing a hex representation of the given color.

* @method Phaser.Color.colorToHexstring

* @static

* @param {number} color - The color channel to get the hex value for, must be a value between 0 and 255).

* @returns {string} A string of length 2 characters, i.e. 255 = FF, 0 = 00.

colorToHexstring: function (color) {

var digits = "0123456789ABCDEF";

var lsd = color % 16;

var msd = (color - lsd) / 16;

var hexified = digits.charAt(msd) + digits.charAt(lsd);

return hexified;

/**

* Interpolates the two given colours based on the supplied step and currentStep properties.

* @method Phaser.Color.interpolateColor

* @static

* @param {number} color1 - The first color value.

* @param {number} color2 - The second color value.

* @param {number} steps - The number of steps to run the interpolation over.

* @param {number} currentStep - The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.

* @param {number} alpha - The alpha of the returned color.

* @returns {number} The interpolated color value.

interpolateColor: function (color1, color2, steps, currentStep, alpha) {

if (typeof alpha === "undefined") { alpha = 255; }

var src1 = Phaser.Color.getRGB(color1);

var src2 = Phaser.Color.getRGB(color2);

var r = (((src2.red - src1.red) * currentStep) / steps) + src1.red;

var g = (((src2.green - src1.green) * currentStep) / steps) + src1.green;

var b = (((src2.blue - src1.blue) * currentStep) / steps) + src1.blue;

return Phaser.Color.getColor32(alpha, r, g, b);

/**

* Interpolates the two given colours based on the supplied step and currentStep properties.

* @method Phaser.Color.interpolateColorWithRGB

* @static

* @param {number} color - The first color value.

* @param {number} r - The red color value, between 0 and 0xFF (255).

* @param {number} g - The green color value, between 0 and 0xFF (255).

* @param {number} b - The blue color value, between 0 and 0xFF (255).

* @param {number} steps - The number of steps to run the interpolation over.

* @param {number} currentStep - The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.

* @returns {number} The interpolated color value.

interpolateColorWithRGB: function (color, r, g, b, steps, currentStep) {

var src = Phaser.Color.getRGB(color);

var or = (((r - src.red) * currentStep) / steps) + src.red;

var og = (((g - src.green) * currentStep) / steps) + src.green;

var ob = (((b - src.blue) * currentStep) / steps) + src.blue;

return Phaser.Color.getColor(or, og, ob);

/**

* Interpolates the two given colours based on the supplied step and currentStep properties.

* @method Phaser.Color.interpolateRGB

* @static

* @param {number} r1 - The red color value, between 0 and 0xFF (255).

* @param {number} g1 - The green color value, between 0 and 0xFF (255).

* @param {number} b1 - The blue color value, between 0 and 0xFF (255).

* @param {number} r2 - The red color value, between 0 and 0xFF (255).

* @param {number} g2 - The green color value, between 0 and 0xFF (255).

* @param {number} b2 - The blue color value, between 0 and 0xFF (255).

* @param {number} steps - The number of steps to run the interpolation over.

* @param {number} currentStep - The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.

* @returns {number} The interpolated color value.

interpolateRGB: function (r1, g1, b1, r2, g2, b2, steps, currentStep) {

var r = (((r2 - r1) * currentStep) / steps) + r1;

var g = (((g2 - g1) * currentStep) / steps) + g1;

var b = (((b2 - b1) * currentStep) / steps) + b1;

return Phaser.Color.getColor(r, g, b);

/**

* Returns a random color value between black and white

* Set the min value to start each channel from the given offset.

* Set the max value to restrict the maximum color used per channel.

* @method Phaser.Color.getRandomColor

* @static

* @param {number} min - The lowest value to use for the color.

* @param {number} max - The highest value to use for the color.

* @param {number} alpha - The alpha value of the returning color (default 255 = fully opaque).

* @returns {number} 32-bit color value with alpha.

getRandomColor: function (min, max, alpha) {

if (typeof min === "undefined") { min = 0; }

if (typeof max === "undefined") { max = 255; }

if (typeof alpha === "undefined") { alpha = 255; }

// Sanity checks

if (max > 255) {

return Phaser.Color.getColor(255, 255, 255);

}

if (min > max) {

return Phaser.Color.getColor(255, 255, 255);

}

var red = min + Math.round(Math.random() * (max - min));

var green = min + Math.round(Math.random() * (max - min));

var blue = min + Math.round(Math.random() * (max - min));

return Phaser.Color.getColor32(alpha, red, green, blue);

/**

* Return the component parts of a color as an Object with the properties alpha, red, green, blue

* Alpha will only be set if it exist in the given color (0xAARRGGBB)

* @method Phaser.Color.getRGB

* @static

* @param {number} color - Color in RGB (0xRRGGBB) or ARGB format (0xAARRGGBB).

* @returns {object} An Object with properties: alpha, red, green, blue.

getRGB: function (color) {

return {

alpha: color >>> 24,

red: color >> 16 & 0xFF,

green: color >> 8 & 0xFF,

blue: color & 0xFF

};

/**

* Returns a CSS friendly string value from the given color.

* @method Phaser.Color.getWebRGB

* @static

* @param {number} color

* @returns {string}A string in the format: 'rgba(r,g,b,a)'

getWebRGB: function (color) {

var alpha = (color >>> 24) / 255;

var red = color >> 16 & 0xFF;

var green = color >> 8 & 0xFF;

var blue = color & 0xFF;

return 'rgba(' + red.toString() + ',' + green.toString() + ',' + blue.toString() + ',' + alpha.toString() + ')';

/**

* Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component, as a value between 0 and 255.

* @method Phaser.Color.getAlpha

* @static

* @param {number} color - In the format 0xAARRGGBB.

* @returns {number} The Alpha component of the color, will be between 0 and 1 (0 being no Alpha (opaque), 1 full Alpha (transparent)).

getAlpha: function (color) {

return color >>> 24;

/**

* Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component as a value between 0 and 1.

* @method Phaser.Color.getAlphaFloat

* @static

* @param {number} color - In the format 0xAARRGGBB.

* @returns {number} The Alpha component of the color, will be between 0 and 1 (0 being no Alpha (opaque), 1 full Alpha (transparent)).

getAlphaFloat: function (color) {

return (color >>> 24) / 255;

/**

* Given a native color value (in the format 0xAARRGGBB) this will return the Red component, as a value between 0 and 255.

* @method Phaser.Color.getRed

* @static

* @param {number} color In the format 0xAARRGGBB.

* @returns {number} The Red component of the color, will be between 0 and 255 (0 being no color, 255 full Red).

getRed: function (color) {

return color >> 16 & 0xFF;

/**

* Given a native color value (in the format 0xAARRGGBB) this will return the Green component, as a value between 0 and 255.

* @method Phaser.Color.getGreen

* @static

* @param {number} color - In the format 0xAARRGGBB.

* @returns {number} The Green component of the color, will be between 0 and 255 (0 being no color, 255 full Green).

getGreen: function (color) {

return color >> 8 & 0xFF;

/**

* Given a native color value (in the format 0xAARRGGBB) this will return the Blue component, as a value between 0 and 255.

* @method Phaser.Color.getBlue

* @static

* @param {number} color - In the format 0xAARRGGBB.

* @returns {number} The Blue component of the color, will be between 0 and 255 (0 being no color, 255 full Blue).

getBlue: function (color) {

return color & 0xFF;

}

};

</pre>

</article>

</section>

</div>

</span>

<br />

Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>

on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.

</span>

</footer>

</div>

</div>

$( function () {

$( "#toc" ).toc( {

selectors : "h1,h2,h3,h4",

showAndHide : false,

scrollTo : 60

} );

$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );

$( "#main span[id^='toc']" ).addClass( "toc-shim" );

} );

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Color.js.html

Latest commit

History

Color.js.html

File metadata and controls