179 lines
		
	
	
		
			7.0 KiB
		
	
	
	
		
			C
		
	
	
	
			
		
		
	
	
			179 lines
		
	
	
		
			7.0 KiB
		
	
	
	
		
			C
		
	
	
	
| /*
 | |
|  * Copyright © 2013 Keith Packard
 | |
|  *
 | |
|  * Permission to use, copy, modify, distribute, and sell this software and its
 | |
|  * documentation for any purpose is hereby granted without fee, provided that
 | |
|  * the above copyright notice appear in all copies and that both that copyright
 | |
|  * notice and this permission notice appear in supporting documentation, and
 | |
|  * that the name of the copyright holders not be used in advertising or
 | |
|  * publicity pertaining to distribution of the software without specific,
 | |
|  * written prior permission.  The copyright holders make no representations
 | |
|  * about the suitability of this software for any purpose.  It is provided "as
 | |
|  * is" without express or implied warranty.
 | |
|  *
 | |
|  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 | |
|  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 | |
|  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 | |
|  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 | |
|  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 | |
|  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 | |
|  * OF THIS SOFTWARE.
 | |
|  */
 | |
| 
 | |
| #ifndef _PRESENT_H_
 | |
| #define _PRESENT_H_
 | |
| 
 | |
| #include <X11/extensions/presentproto.h>
 | |
| #include "randrstr.h"
 | |
| #include "presentext.h"
 | |
| 
 | |
| typedef enum {
 | |
|     PRESENT_FLIP_REASON_UNKNOWN,
 | |
|     PRESENT_FLIP_REASON_BUFFER_FORMAT,
 | |
| 
 | |
|     /* Don't add new flip reasons after the TearFree ones, since it's expected
 | |
|      * that the TearFree reasons are the highest ones in order to allow doing
 | |
|      * `reason >= PRESENT_FLIP_REASON_DRIVER_TEARFREE` to check if a reason is
 | |
|      * PRESENT_FLIP_REASON_DRIVER_TEARFREE{_FLIPPING}.
 | |
|      */
 | |
|     PRESENT_FLIP_REASON_DRIVER_TEARFREE,
 | |
|     PRESENT_FLIP_REASON_DRIVER_TEARFREE_FLIPPING
 | |
| } PresentFlipReason;
 | |
| 
 | |
| typedef struct present_vblank present_vblank_rec, *present_vblank_ptr;
 | |
| 
 | |
| /* Return the current CRTC for 'window'.
 | |
|  */
 | |
| typedef RRCrtcPtr (*present_get_crtc_ptr) (WindowPtr window);
 | |
| 
 | |
| /* Return the current ust/msc for 'crtc'
 | |
|  */
 | |
| typedef int (*present_get_ust_msc_ptr) (RRCrtcPtr crtc, uint64_t *ust, uint64_t *msc);
 | |
| typedef int (*present_wnmd_get_ust_msc_ptr) (WindowPtr window, uint64_t *ust, uint64_t *msc);
 | |
| 
 | |
| /* Queue callback on 'crtc' for time 'msc'. Call present_event_notify with 'event_id'
 | |
|  * at or after 'msc'. Return false if it didn't happen (which might occur if 'crtc'
 | |
|  * is not currently generating vblanks).
 | |
|  */
 | |
| typedef Bool (*present_queue_vblank_ptr) (RRCrtcPtr crtc,
 | |
|                                           uint64_t event_id,
 | |
|                                           uint64_t msc);
 | |
| typedef Bool (*present_wnmd_queue_vblank_ptr) (WindowPtr window,
 | |
|                                                RRCrtcPtr crtc,
 | |
|                                                uint64_t event_id,
 | |
|                                                uint64_t msc);
 | |
| 
 | |
| /* Abort pending vblank. The extension is no longer interested in
 | |
|  * 'event_id' which was to be notified at 'msc'. If possible, the
 | |
|  * driver is free to de-queue the notification.
 | |
|  */
 | |
| typedef void (*present_abort_vblank_ptr) (RRCrtcPtr crtc, uint64_t event_id, uint64_t msc);
 | |
| typedef void (*present_wnmd_abort_vblank_ptr) (WindowPtr window,
 | |
|                                                RRCrtcPtr crtc,
 | |
|                                                uint64_t event_id,
 | |
|                                                uint64_t msc);
 | |
| 
 | |
| /* Flush pending drawing on 'window' to the hardware.
 | |
|  */
 | |
| typedef void (*present_flush_ptr) (WindowPtr window);
 | |
| 
 | |
| /* Check if 'pixmap' is suitable for flipping to 'window'.
 | |
|  */
 | |
| typedef Bool (*present_check_flip_ptr) (RRCrtcPtr crtc, WindowPtr window, PixmapPtr pixmap, Bool sync_flip);
 | |
| 
 | |
| /* Same as 'check_flip' but it can return a 'reason' why the flip would fail.
 | |
|  */
 | |
| typedef Bool (*present_check_flip2_ptr) (RRCrtcPtr crtc, WindowPtr window, PixmapPtr pixmap, Bool sync_flip, PresentFlipReason *reason);
 | |
| 
 | |
| /* Flip pixmap, return false if it didn't happen.
 | |
|  *
 | |
|  * 'crtc' is to be used for any necessary synchronization.
 | |
|  *
 | |
|  * 'sync_flip' requests that the flip be performed at the next
 | |
|  * vertical blank interval to avoid tearing artifacts. If false, the
 | |
|  * flip should be performed as soon as possible.
 | |
|  *
 | |
|  * present_event_notify should be called with 'event_id' when the flip
 | |
|  * occurs
 | |
|  */
 | |
| typedef Bool (*present_flip_ptr) (RRCrtcPtr crtc,
 | |
|                                   uint64_t event_id,
 | |
|                                   uint64_t target_msc,
 | |
|                                   PixmapPtr pixmap,
 | |
|                                   Bool sync_flip);
 | |
| /* Flip pixmap for window, return false if it didn't happen.
 | |
|  *
 | |
|  * Like present_flip_ptr, additionally with:
 | |
|  *
 | |
|  * 'window' used for synchronization.
 | |
|  *
 | |
|  */
 | |
| typedef Bool (*present_wnmd_flip_ptr) (WindowPtr window,
 | |
|                                        RRCrtcPtr crtc,
 | |
|                                        uint64_t event_id,
 | |
|                                        uint64_t target_msc,
 | |
|                                        PixmapPtr pixmap,
 | |
|                                        Bool sync_flip,
 | |
|                                        RegionPtr damage);
 | |
| 
 | |
| /* "unflip" back to the regular screen scanout buffer
 | |
|  *
 | |
|  * present_event_notify should be called with 'event_id' when the unflip occurs.
 | |
|  */
 | |
| typedef void (*present_unflip_ptr) (ScreenPtr screen,
 | |
|                                     uint64_t event_id);
 | |
| 
 | |
| /* Doing flips has been discontinued.
 | |
|  *
 | |
|  * Inform driver for potential cleanup on its side.
 | |
|  */
 | |
| typedef void (*present_wnmd_flips_stop_ptr) (WindowPtr window);
 | |
| 
 | |
| #define PRESENT_SCREEN_INFO_VERSION        1
 | |
| 
 | |
| typedef struct present_screen_info {
 | |
|     uint32_t                            version;
 | |
| 
 | |
|     present_get_crtc_ptr                get_crtc;
 | |
|     present_get_ust_msc_ptr             get_ust_msc;
 | |
|     present_queue_vblank_ptr            queue_vblank;
 | |
|     present_abort_vblank_ptr            abort_vblank;
 | |
|     present_flush_ptr                   flush;
 | |
|     uint32_t                            capabilities;
 | |
|     present_check_flip_ptr              check_flip;
 | |
|     present_flip_ptr                    flip;
 | |
|     present_unflip_ptr                  unflip;
 | |
|     present_check_flip2_ptr             check_flip2;
 | |
| 
 | |
| } present_screen_info_rec, *present_screen_info_ptr;
 | |
| 
 | |
| /*
 | |
|  * Called when 'event_id' occurs. 'ust' and 'msc' indicate when the
 | |
|  * event actually happened
 | |
|  */
 | |
| extern _X_EXPORT void
 | |
| present_event_notify(uint64_t event_id, uint64_t ust, uint64_t msc);
 | |
| 
 | |
| extern _X_EXPORT Bool
 | |
| present_screen_init(ScreenPtr screen, present_screen_info_ptr info);
 | |
| 
 | |
| extern _X_EXPORT void
 | |
| present_check_flips(WindowPtr window);
 | |
| 
 | |
| typedef void (*present_complete_notify_proc)(WindowPtr window,
 | |
|                                              CARD8 kind,
 | |
|                                              CARD8 mode,
 | |
|                                              CARD32 serial,
 | |
|                                              uint64_t ust,
 | |
|                                              uint64_t msc);
 | |
| 
 | |
| extern _X_EXPORT void
 | |
| present_register_complete_notify(present_complete_notify_proc proc);
 | |
| 
 | |
| extern _X_EXPORT Bool
 | |
| present_can_window_flip(WindowPtr window);
 | |
| 
 | |
| extern _X_EXPORT uint32_t FakeScreenFps;
 | |
| 
 | |
| #endif /* _PRESENT_H_ */
 |