xref: /aoo42x/main/offapi/com/sun/star/rendering/XVolatileBitmap.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_rendering_XVolatileBitmap_idl__
#define __com_sun_star_rendering_XVolatileBitmap_idl__

#ifndef __com_sun_star_rendering_XBitmap_idl__
#include <com/sun/star/rendering/XBitmap.idl>
#endif

module com { module sun { module star { module rendering {

/** This is a specialized interface to a volatile bitmap (which can
    become invalid at any point in time).
 */
published interface XVolatileBitmap : XBitmap
{
    /** Query whether this volatile bitmap still has valid content.

        As the video RAM allocated to this bitmap can be reclaimed at
        any time, a return value of true here does not imply that the
        next draw operation with this bitmap will succeed. Instead,
        the exception VolatileContentDestroyed might then be thrown,
        if lost bitmap data is accessed.
     */
    boolean	isValid();
};

}; }; }; };

#endif