1*d1766043SAndrew Rist/************************************************************** 2*d1766043SAndrew Rist * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBufferController_idl__ 24cdf0e10cSrcweir#define __com_sun_star_rendering_XBufferController_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 30cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 34cdf0e10cSrcweir 35cdf0e10cSrcweir/** Interface providing access to double/multi-buffer facilities of 36cdf0e10cSrcweir screen devices.<p> 37cdf0e10cSrcweir 38cdf0e10cSrcweir This interface provides methods to enable and control 39cdf0e10cSrcweir double/multi-buffering facilities on screen devices.<p> 40cdf0e10cSrcweir 41cdf0e10cSrcweir @since OOo 2.0 42cdf0e10cSrcweir */ 43cdf0e10cSrcweirpublished interface XBufferController : ::com::sun::star::uno::XInterface 44cdf0e10cSrcweir{ 45cdf0e10cSrcweir /** Create the given number of background buffers.<p> 46cdf0e10cSrcweir 47cdf0e10cSrcweir There's one buffer implicitely available, which is the canvas 48cdf0e10cSrcweir surface itself. Thus, calling <code>createBuffers(1)</code> 49cdf0e10cSrcweir creates a double-buffered object.<p> 50cdf0e10cSrcweir 51cdf0e10cSrcweir @param nBuffers 52cdf0e10cSrcweir The number of background<buffers requested. Must be greater 53cdf0e10cSrcweir than 0. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @return the number of actually generated buffers, which might 56cdf0e10cSrcweir be between 0 (no double-buffering available) and nBuffers. 57cdf0e10cSrcweir 58cdf0e10cSrcweir @throws <type>com::sun::star::lang::IllegalArgumentException</type> 59cdf0e10cSrcweir if nBuffers is smaller than one. 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir long createBuffers( [in] long nBuffers ) 62cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException); 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir 66cdf0e10cSrcweir /** Destroy all buffers generated via this object. 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir void destroyBuffers(); 69cdf0e10cSrcweir 70cdf0e10cSrcweir //------------------------------------------------------------------------- 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** Switch the display to show the specified buffer.<p> 73cdf0e10cSrcweir 74cdf0e10cSrcweir The method returns, when the switch is performed and the 75cdf0e10cSrcweir selected buffer is shown on screen, or immediately when an 76cdf0e10cSrcweir error occurs. If the switch was successful, subsequent render 77cdf0e10cSrcweir operations will be directed to the new backbuffer.<p> 78cdf0e10cSrcweir 79cdf0e10cSrcweir Use this method if you need your screen display to be in sync 80cdf0e10cSrcweir with other things, e.g. sound playback.<p> 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param bUpdateAll 83cdf0e10cSrcweir When <TRUE/>, update the whole screen. When <FALSE/>, 84cdf0e10cSrcweir implementation is permitted to restrict update to areas the 85cdf0e10cSrcweir canvas itself changed (e.g. because of render operations, or 86cdf0e10cSrcweir changes on the sprites). The former is useful for updates 87cdf0e10cSrcweir after window expose events, the latter for animation display. 88cdf0e10cSrcweir 89cdf0e10cSrcweir @return whether the switch was performed successfully. 90cdf0e10cSrcweir 91cdf0e10cSrcweir @throws <type>com::sun::star::lang::IllegalArgumentException</type> 92cdf0e10cSrcweir if nBuffer is outside the permissible range. 93cdf0e10cSrcweir */ 94cdf0e10cSrcweir boolean showBuffer( [in] boolean bUpdateAll ); 95cdf0e10cSrcweir 96cdf0e10cSrcweir //------------------------------------------------------------------------- 97cdf0e10cSrcweir 98cdf0e10cSrcweir /** Schedule the display of the specified buffer.<p> 99cdf0e10cSrcweir 100cdf0e10cSrcweir The method returns, when the switching of the buffer is 101cdf0e10cSrcweir successfully scheduled, or immediately when an error 102cdf0e10cSrcweir occurs. If the switch was successful, subsequent render 103cdf0e10cSrcweir operations will be directed to the new backbuffer. Note that, 104cdf0e10cSrcweir if the buffer switching is exceedingly slow, or the frequency 105cdf0e10cSrcweir of switchBuffer() is exceedingly high, the buffer scheduled 106cdf0e10cSrcweir for display here might become the current render target 107cdf0e10cSrcweir <em>before</em> it is fully displayed on screen. In this case, 108cdf0e10cSrcweir any rendering operation to this buffer will block, until it is 109cdf0e10cSrcweir safe to perform the operation without visible cluttering.<p> 110cdf0e10cSrcweir 111cdf0e10cSrcweir Use this method if you favor maximal render speed, but don't 112cdf0e10cSrcweir necessarily require your screen display to be in sync with 113cdf0e10cSrcweir other things, e.g. sound playback.<p> 114cdf0e10cSrcweir 115cdf0e10cSrcweir @param bUpdateAll 116cdf0e10cSrcweir When <TRUE/>, update the whole screen. When <FALSE/>, 117cdf0e10cSrcweir implementation is permitted to restrict update to areas the 118cdf0e10cSrcweir canvas itself changed (e.g. because of render operations, or 119cdf0e10cSrcweir changes on the sprites). The former is useful for updates 120cdf0e10cSrcweir after window expose events, the latter for animation display. 121cdf0e10cSrcweir 122cdf0e10cSrcweir @return whether the switch was performed successfully. 123cdf0e10cSrcweir */ 124cdf0e10cSrcweir boolean switchBuffer( [in] boolean bUpdateAll ); 125cdf0e10cSrcweir 126cdf0e10cSrcweir}; 127cdf0e10cSrcweir 128cdf0e10cSrcweir}; }; }; }; 129cdf0e10cSrcweir 130cdf0e10cSrcweir#endif 131