1 /*
   2  * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.prism;
  27 
  28 import com.sun.javafx.geom.Rectangle;
  29 
  30 public interface Presentable extends RenderTarget {
  31     /**
  32      * Locks any underlying resources needed for a createGraphics/prepare/present
  33      * sequence and returns a boolean indicating if the presentable needs to be
  34      * recreated.
  35      * If the method returns true and the Presentable implements
  36      * {@link GraphicsResource} then its {@code dispose()} method will be
  37      * called prior to recreating a new {@code Presentable} object and
  38      * so no resource should need to be locked in that case.
  39      * The resources will be unlocked in either {@link #prepare()} or
  40      * {@link #present()}.
  41      *
  42      * @param pState The presentation state for the upcoming pulse
  43      * @return true if the caller should recreate the Presentable
  44      */
  45     public boolean lockResources(PresentableState pState);
  46 
  47     /**
  48      * display the indicated region to the user.
  49      * @param dirtyregion display region or null for full area
  50      * @return true if the provided region was successfully displayed,
  51      * false otherwise
  52      */
  53     public boolean prepare(Rectangle dirtyregion);
  54 
  55     /**
  56      * present the prepared region to the user.
  57      */
  58     public boolean present();
  59 
  60     public float getPixelScaleFactorX();
  61     public float getPixelScaleFactorY();
  62 }