Source: Core/PixelFormat.js

  1. /*global define*/
  2. define([
  3.         '../Renderer/WebGLConstants',
  4.         './freezeObject'
  5.     ], function(
  6.         WebGLConstants,
  7.         freezeObject) {
  8.     'use strict';
  10.     /**
  11.      * The format of a pixel, i.e., the number of components it has and what they represent.
  12.      *
  13.      * @exports PixelFormat
  14.      */
  15.     var PixelFormat = {
  16.         /**
  17.          * A pixel format containing a depth value.
  18.          *
  19.          * @type {Number}
  20.          * @constant
  21.          */
  22.         DEPTH_COMPONENT : WebGLConstants.DEPTH_COMPONENT,
  24.         /**
  25.          * A pixel format containing a depth and stencil value, most often used with {@link PixelDatatype.UNSIGNED_INT_24_8}.
  26.          *
  27.          * @type {Number}
  28.          * @constant
  29.          */
  30.         DEPTH_STENCIL : WebGLConstants.DEPTH_STENCIL,
  32.         /**
  33.          * A pixel format containing an alpha channel.
  34.          *
  35.          * @type {Number}
  36.          * @constant
  37.          */
  38.         ALPHA : WebGLConstants.ALPHA,
  40.         /**
  41.          * A pixel format containing red, green, and blue channels.
  42.          *
  43.          * @type {Number}
  44.          * @constant
  45.          */
  46.         RGB : WebGLConstants.RGB,
  48.         /**
  49.          * A pixel format containing red, green, blue, and alpha channels.
  50.          *
  51.          * @type {Number}
  52.          * @constant
  53.          */
  54.         RGBA : WebGLConstants.RGBA,
  56.         /**
  57.          * A pixel format containing a luminance (intensity) channel.
  58.          *
  59.          * @type {Number}
  60.          * @constant
  61.          */
  62.         LUMINANCE : WebGLConstants.LUMINANCE,
  64.         /**
  65.          * A pixel format containing luminance (intensity) and alpha channels.
  66.          *
  67.          * @type {Number}
  68.          * @constant
  69.          */
  70.         LUMINANCE_ALPHA : WebGLConstants.LUMINANCE_ALPHA,
  72.         /**
  73.          * @private
  74.          */
  75.         validate : function(pixelFormat) {
  76.             return pixelFormat === PixelFormat.DEPTH_COMPONENT ||
  77.                    pixelFormat === PixelFormat.DEPTH_STENCIL ||
  78.                    pixelFormat === PixelFormat.ALPHA ||
  79.                    pixelFormat === PixelFormat.RGB ||
  80.                    pixelFormat === PixelFormat.RGBA ||
  81.                    pixelFormat === PixelFormat.LUMINANCE ||
  82.                    pixelFormat === PixelFormat.LUMINANCE_ALPHA;
  83.         },
  85.         /**
  86.          * @private
  87.          */
  88.         isColorFormat : function(pixelFormat) {
  89.             return pixelFormat === PixelFormat.ALPHA ||
  90.                    pixelFormat === PixelFormat.RGB ||
  91.                    pixelFormat === PixelFormat.RGBA ||
  92.                    pixelFormat === PixelFormat.LUMINANCE ||
  93.                    pixelFormat === PixelFormat.LUMINANCE_ALPHA;
  94.         },
  96.         /**
  97.          * @private
  98.          */
  99.         isDepthFormat : function(pixelFormat) {
  100.             return pixelFormat === PixelFormat.DEPTH_COMPONENT ||
  101.                    pixelFormat === PixelFormat.DEPTH_STENCIL;
  102.         }
  103.     };
  105.     return freezeObject(PixelFormat);
  106. });