Apache Zeta Components Manual :: File Source for colorspace.php

Source for file colorspace.php

Documentation is available at colorspace.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageColorspaceFilters interface.
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @package ImageConversion
  23.  * @version //autogentag//
  24.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  25.  * @filesource
  26.  */
  27.  
  28. /**
  29.  * This interface has to implemented by ezcImageFilters classes to
  30.  * support colorspace filters.
  31.  *
  32.  * @see ezcImageHandler
  33.  * @see ezcImageTransformation
  34.  * @see ezcImageFiltersInterface
  35.  *
  36.  * @package ImageConversion
  37.  * @version //autogentag//
  38.  */
  39. {
  40.     /**
  41.      * Grey color space.
  42.      * 
  43.      * @var int 
  44.      */
  45.     const COLORSPACE_GREY 1;
  46.  
  47.     /**
  48.      * Sepia color space.
  49.      * 
  50.      * @var int 
  51.      */
  52.     const COLORSPACE_SEPIA 2;
  53.  
  54.     /**
  55.      * Monochrome color space.
  56.      * 
  57.      * @var int 
  58.      */
  59.     const COLORSPACE_MONOCHROME 3;
  60.  
  61.     /**
  62.      * Colorspace filter.
  63.      * Transform the colorspace of the picture. The following colorspaces are
  64.      * supported:
  65.      *
  66.      * - {@link self::COLORSPACE_GREY} - 255 grey colors
  67.      * - {@link self::COLORSPACE_SEPIA} - Sepia colors
  68.      * - {@link self::COLORSPACE_MONOCHROME} - 2 colors black and white
  69.      * 
  70.      * @param int $space Colorspace, one of self::COLORSPACE_* constants.
  71.      * @return void 
  72.      *
  73.      * @throws ezcImageInvalidReferenceException
  74.      *          If no valid resource for the active reference could be found.
  75.      * @throws ezcImageFilterFailedException
  76.      *          If the parameter submitted as the colorspace was not within the
  77.      *          self::COLORSPACE_* constants
  78.      *          If the operation performed by the the filter failed.
  79.      * @throws ezcBaseValueException
  80.      *          If a submitted parameter was out of range or type.
  81.      */
  82.     function colorspace$space );
  83. }
  84. ?>
Documentation generated by phpDocumentor 1.4.3