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

Source for file effect.php

Documentation is available at effect.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageEffectFilters 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 be implemented by ezcImageFilters classes to
  30.  * support effect filters.
  31.  *
  32.  * @see ezcImageHandler
  33.  * @see ezcImageTransformation
  34.  * @see ezcImageFiltersInterface
  35.  *
  36.  * @package ImageConversion
  37.  * @version //autogentag//
  38.  */
  39. {
  40.     /**
  41.      * Noise filter.
  42.      * Apply a noise transformation to the image. Valid values are the following
  43.      * strings:
  44.      * - 'Uniform'
  45.      * - 'Gaussian'
  46.      * - 'Multiplicative'
  47.      * - 'Impulse'
  48.      * - 'Laplacian'
  49.      * - 'Poisson'
  50.      *
  51.      * @param strings $value Noise value as described above.
  52.      * @return void 
  53.      *
  54.      * @throws ezcImageFilterFailedException
  55.      *          If the operation performed by the the filter failed.
  56.      * @throws ezcBaseValueException
  57.      *          If a submitted parameter was out of range or type.
  58.      * @throws ezcImageInvalidReferenceException
  59.      *          No loaded file could be found or an error destroyed a loaded reference.
  60.      */
  61.     function noise$value );
  62.  
  63.     /**
  64.      * Swirl filter.
  65.      * Applies a swirl with the given intense to the image.
  66.      *
  67.      * @param int $value Intense of swirl.
  68.      * @return void 
  69.      *
  70.      * @throws ezcImageInvalidReferenceException
  71.      *          No loaded file could be found or an error destroyed a loaded reference.
  72.      * @throws ezcImageFilterFailedException
  73.      *          If the operation performed by the the filter failed.
  74.      * @throws ezcBaseValueException
  75.      *          If a submitted parameter was out of range or type.
  76.      */
  77.     function swirl$value );
  78.  
  79.     /**
  80.      * Border filter.
  81.      * Adds a border to the image. The width is measured in pixel. The color is
  82.      * defined in an array of hex values:
  83.      *
  84.      * <code>
  85.      * array(
  86.      *      0 => <red value>,
  87.      *      1 => <green value>,
  88.      *      2 => <blue value>,
  89.      * );
  90.      * </code>
  91.      *
  92.      * @param int $width        Width of the border.
  93.      * @param array(int) $color Color.
  94.      * @return void 
  95.      * 
  96.      * @throws ezcImageInvalidReferenceException
  97.      *          No loaded file could be found or an error destroyed a loaded reference.
  98.      * @throws ezcImageFilterFailedException
  99.      *          If the operation performed by the the filter failed.
  100.      * @throws ezcBaseValueException
  101.      *          If a submitted parameter was out of range or type.
  102.      */
  103.     function border$widtharray $color );
  104. }
  105. ?>
Documentation generated by phpDocumentor 1.4.3