/*
 * Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.prism;

import com.sun.javafx.geom.Rectangle;

public interface Presentable extends RenderTarget {
    
Locks any underlying resources needed for a createGraphics/prepare/present sequence and returns a boolean indicating if the presentable needs to be recreated. If the method returns true and the Presentable implements GraphicsResource then its dispose() method will be called prior to recreating a new Presentable object and so no resource should need to be locked in that case. The resources will be unlocked in either prepare() or present().
Params:
  • pState – The presentation state for the upcoming pulse
Returns:true if the caller should recreate the Presentable
/** * Locks any underlying resources needed for a createGraphics/prepare/present * sequence and returns a boolean indicating if the presentable needs to be * recreated. * If the method returns true and the Presentable implements * {@link GraphicsResource} then its {@code dispose()} method will be * called prior to recreating a new {@code Presentable} object and * so no resource should need to be locked in that case. * The resources will be unlocked in either {@link #prepare()} or * {@link #present()}. * * @param pState The presentation state for the upcoming pulse * @return true if the caller should recreate the Presentable */
public boolean lockResources(PresentableState pState);
display the indicated region to the user.
Params:
  • dirtyregion – display region or null for full area
Returns:true if the provided region was successfully displayed, false otherwise
/** * display the indicated region to the user. * @param dirtyregion display region or null for full area * @return true if the provided region was successfully displayed, * false otherwise */
public boolean prepare(Rectangle dirtyregion);
present the prepared region to the user.
/** * present the prepared region to the user. */
public boolean present(); public float getPixelScaleFactorX(); public float getPixelScaleFactorY(); }