Jogamp
f6101034b555a756faae420a5f5f64d54f42e1c0
[jogl.git] / src / nativewindow / classes / javax / media / nativewindow / ScalableSurface.java
1 /**
2  * Copyright 2014 JogAmp Community. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification, are
5  * permitted provided that the following conditions are met:
6  *
7  *    1. Redistributions of source code must retain the above copyright notice, this list of
8  *       conditions and the following disclaimer.
9  *
10  *    2. Redistributions in binary form must reproduce the above copyright notice, this list
11  *       of conditions and the following disclaimer in the documentation and/or other materials
12  *       provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  *
24  * The views and conclusions contained in the software and documentation are those of the
25  * authors and should not be interpreted as representing official policies, either expressed
26  * or implied, of JogAmp Community.
27  */
28
29 package javax.media.nativewindow;
30
31 /**
32  * Adding mutable surface pixel scale property to implementing class, usually to a {@link NativeSurface} implementation,
33  * see {@link #setSurfaceScale(int[], int[])}.
34  */
35 public interface ScalableSurface {
36   /** Setting surface-pixel-scale of {@value}, results in same pixel- and window-units. */
37   public static final int IDENTITY_PIXELSCALE = 1;
38   /** Setting surface-pixel-scale of {@value}, results in maximum platform dependent pixel-scale, i.e. pixel-units >> window-units where available. */
39   public static final int AUTOMAX_PIXELSCALE = 0;
40
41   /**
42    * Request a pixel scale in x- and y-direction for the associated {@link NativeSurface}
43    * and return the validated requested value, see below.
44    * <p>
45    * Default pixel scale request for both directions is {@link #AUTOMAX_PIXELSCALE}.
46    * </p>
47    * <p>
48    * In case platform only supports uniform pixel scale, i.e. one scale for both directions,
49    * either {@link #AUTOMAX_PIXELSCALE} or the maximum requested pixel scale component is used.
50    * </p>
51    * <p>
52    * The <i>requested</i> pixel scale will be validated against platform limits before native scale-setup,
53    * i.e. clipped to {@link #IDENTITY_PIXELSCALE} if not supported or clipped to the platform maximum.
54    * </p>
55    * <p>
56    * The actual <i>realized</i> pixel scale values of the {@link NativeSurface}
57    * can be queried via {@link #getSurfaceScale(int[])} or
58    * computed via <code>surface.{@link NativeSurface#convertToPixelUnits(int[]) convertToPixelUnits}(new int[] { 1, 1 })</code>
59    * </p>
60    * @param result int[2] storage for the result, maybe null
61    * @param pixelScale <i>requested</i> surface pixel scale int[2] values for x- and y-direction.
62    * @return the passed storage containing the validated requested pixelSize for chaining, if storage is not null
63    */
64   public int[] setSurfaceScale(final int[] result, final int[] pixelScale);
65
66   /**
67    * Returns the current pixel scale of the associated {@link NativeSurface}.
68    *
69    * @param result int[2] storage for the result
70    * @return the passed storage containing the current pixelSize for chaining
71    */
72   public int[] getSurfaceScale(final int[] result);
73 }
74
http://JogAmp.org git info: FAQ, tutorial and man pages.