dri_interface.h

Go to the documentation of this file.

/*
 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2007-2008 Red Hat, Inc.
 * (C) Copyright IBM Corporation 2004
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * on the rights to use, copy, modify, merge, publish, distribute, sub
 * license, and/or sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef DRI_INTERFACE_H
#define DRI_INTERFACE_H

/* For archs with no drm.h */
#if !defined(__APPLE__) && !defined(__CYGWIN__)
#include <drm.h>
#else
typedef unsigned int drm_context_t;
typedef unsigned int drm_drawable_t;
typedef struct drm_clip_rect drm_clip_rect_t;
#endif

typedef struct __DRIdisplayRec      __DRIdisplay;
typedef struct __DRIscreenRec       __DRIscreen;
typedef struct __DRIcontextRec      __DRIcontext;
typedef struct __DRIdrawableRec     __DRIdrawable;
typedef struct __DRIconfigRec       __DRIconfig;
typedef struct __DRIframebufferRec  __DRIframebuffer;
typedef struct __DRIversionRec      __DRIversion;

typedef struct __DRIcoreExtensionRec        __DRIcoreExtension;
typedef struct __DRIextensionRec        __DRIextension;
typedef struct __DRIcopySubBufferExtensionRec   __DRIcopySubBufferExtension;
typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension;
typedef struct __DRIallocateExtensionRec    __DRIallocateExtension;
typedef struct __DRIframeTrackingExtensionRec   __DRIframeTrackingExtension;
typedef struct __DRImediaStreamCounterExtensionRec  __DRImediaStreamCounterExtension;
typedef struct __DRItexOffsetExtensionRec   __DRItexOffsetExtension;
typedef struct __DRItexBufferExtensionRec   __DRItexBufferExtension;
typedef struct __DRIlegacyExtensionRec      __DRIlegacyExtension;
typedef struct __DRIswrastExtensionRec      __DRIswrastExtension;
typedef struct __DRIbufferRec           __DRIbuffer;
typedef struct __DRIdri2ExtensionRec        __DRIdri2Extension;
typedef struct __DRIdri2LoaderExtensionRec  __DRIdri2LoaderExtension;

struct __DRIextensionRec {
    const char *name;
    int version;
};

#define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
#define __DRI_READ_DRAWABLE_VERSION 1

#define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
#define __DRI_COPY_SUB_BUFFER_VERSION 1
struct __DRIcopySubBufferExtensionRec {
    __DRIextension base;
    void (*copySubBuffer)(__DRIdrawable *drawable, int x, int y, int w, int h);
};

#define __DRI_SWAP_CONTROL "DRI_SwapControl"
#define __DRI_SWAP_CONTROL_VERSION 1
struct __DRIswapControlExtensionRec {
    __DRIextension base;
    void (*setSwapInterval)(__DRIdrawable *drawable, unsigned int inteval);
    unsigned int (*getSwapInterval)(__DRIdrawable *drawable);
};

#define __DRI_ALLOCATE "DRI_Allocate"
#define __DRI_ALLOCATE_VERSION 1
struct __DRIallocateExtensionRec {
    __DRIextension base;

    void *(*allocateMemory)(__DRIscreen *screen, GLsizei size,
                GLfloat readfreq, GLfloat writefreq,
                GLfloat priority);
   
    void (*freeMemory)(__DRIscreen *screen, GLvoid *pointer);
   
    GLuint (*memoryOffset)(__DRIscreen *screen, const GLvoid *pointer);
};

#define __DRI_FRAME_TRACKING "DRI_FrameTracking"
#define __DRI_FRAME_TRACKING_VERSION 1
struct __DRIframeTrackingExtensionRec {
    __DRIextension base;

    int (*frameTracking)(__DRIdrawable *drawable, GLboolean enable);

    int (*queryFrameTracking)(__DRIdrawable *drawable,
                  int64_t * sbc, int64_t * missedFrames,
                  float * lastMissedUsage, float * usage);
};


#define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
#define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
struct __DRImediaStreamCounterExtensionRec {
    __DRIextension base;

    int (*waitForMSC)(__DRIdrawable *drawable,
              int64_t target_msc, int64_t divisor, int64_t remainder,
              int64_t * msc, int64_t * sbc);

    int (*getDrawableMSC)(__DRIscreen *screen, __DRIdrawable *drawable,
              int64_t *msc);
};


#define __DRI_TEX_OFFSET "DRI_TexOffset"
#define __DRI_TEX_OFFSET_VERSION 1
struct __DRItexOffsetExtensionRec {
    __DRIextension base;

    void (*setTexOffset)(__DRIcontext *pDRICtx, GLint texname,
             unsigned long long offset, GLint depth, GLuint pitch);
};


#define __DRI_TEX_BUFFER "DRI_TexBuffer"
#define __DRI_TEX_BUFFER_VERSION 1
struct __DRItexBufferExtensionRec {
    __DRIextension base;

    void (*setTexBuffer)(__DRIcontext *pDRICtx,
             GLint target,
             __DRIdrawable *pDraw);
};


extern const char __driConfigOptions[];

typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension;
typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension;
typedef struct __DRIdamageExtensionRec __DRIdamageExtension;
typedef struct __DRIloaderExtensionRec __DRIloaderExtension;
typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension;


#define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
#define __DRI_GET_DRAWABLE_INFO_VERSION 1
struct __DRIgetDrawableInfoExtensionRec {
    __DRIextension base;

    GLboolean (* getDrawableInfo) ( __DRIdrawable *drawable,
    unsigned int * index, unsigned int * stamp,
        int * x, int * y, int * width, int * height,
        int * numClipRects, drm_clip_rect_t ** pClipRects,
        int * backX, int * backY,
    int * numBackClipRects, drm_clip_rect_t ** pBackClipRects,
    void *loaderPrivate);
};

#define __DRI_SYSTEM_TIME "DRI_SystemTime"
#define __DRI_SYSTEM_TIME_VERSION 1
struct __DRIsystemTimeExtensionRec {
    __DRIextension base;

    int (*getUST)(int64_t * ust);

    GLboolean (*getMSCRate)(__DRIdrawable *draw,
                int32_t * numerator, int32_t * denominator,
                void *loaderPrivate);
};

#define __DRI_DAMAGE "DRI_Damage"
#define __DRI_DAMAGE_VERSION 1
struct __DRIdamageExtensionRec {
    __DRIextension base;

    void (*reportDamage)(__DRIdrawable *draw,
             int x, int y,
             drm_clip_rect_t *rects, int num_rects,
             GLboolean front_buffer,
             void *loaderPrivate);
};

#define __DRI_SWRAST_IMAGE_OP_DRAW  1
#define __DRI_SWRAST_IMAGE_OP_CLEAR 2
#define __DRI_SWRAST_IMAGE_OP_SWAP  3

#define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
#define __DRI_SWRAST_LOADER_VERSION 1
struct __DRIswrastLoaderExtensionRec {
    __DRIextension base;

    /*
     * Drawable position and size
     */
    void (*getDrawableInfo)(__DRIdrawable *drawable,
                int *x, int *y, int *width, int *height,
                void *loaderPrivate);

    void (*putImage)(__DRIdrawable *drawable, int op,
             int x, int y, int width, int height, char *data,
             void *loaderPrivate);

    void (*getImage)(__DRIdrawable *drawable,
             int x, int y, int width, int height, char *data,
             void *loaderPrivate);
};

#define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"

#define __DRI_ATTRIB_BUFFER_SIZE         1
#define __DRI_ATTRIB_LEVEL           2
#define __DRI_ATTRIB_RED_SIZE            3
#define __DRI_ATTRIB_GREEN_SIZE          4
#define __DRI_ATTRIB_BLUE_SIZE           5
#define __DRI_ATTRIB_LUMINANCE_SIZE      6
#define __DRI_ATTRIB_ALPHA_SIZE          7
#define __DRI_ATTRIB_ALPHA_MASK_SIZE         8
#define __DRI_ATTRIB_DEPTH_SIZE          9
#define __DRI_ATTRIB_STENCIL_SIZE       10
#define __DRI_ATTRIB_ACCUM_RED_SIZE     11
#define __DRI_ATTRIB_ACCUM_GREEN_SIZE       12
#define __DRI_ATTRIB_ACCUM_BLUE_SIZE        13
#define __DRI_ATTRIB_ACCUM_ALPHA_SIZE       14
#define __DRI_ATTRIB_SAMPLE_BUFFERS     15
#define __DRI_ATTRIB_SAMPLES            16
#define __DRI_ATTRIB_RENDER_TYPE        17
#define __DRI_ATTRIB_CONFIG_CAVEAT      18
#define __DRI_ATTRIB_CONFORMANT         19
#define __DRI_ATTRIB_DOUBLE_BUFFER      20
#define __DRI_ATTRIB_STEREO         21
#define __DRI_ATTRIB_AUX_BUFFERS        22
#define __DRI_ATTRIB_TRANSPARENT_TYPE       23
#define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE    24
#define __DRI_ATTRIB_TRANSPARENT_RED_VALUE  25
#define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE    26
#define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
#define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE    28
#define __DRI_ATTRIB_FLOAT_MODE         29
#define __DRI_ATTRIB_RED_MASK           30
#define __DRI_ATTRIB_GREEN_MASK         31
#define __DRI_ATTRIB_BLUE_MASK          32
#define __DRI_ATTRIB_ALPHA_MASK         33
#define __DRI_ATTRIB_MAX_PBUFFER_WIDTH      34
#define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT     35
#define __DRI_ATTRIB_MAX_PBUFFER_PIXELS     36
#define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH  37
#define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
#define __DRI_ATTRIB_VISUAL_SELECT_GROUP    39
#define __DRI_ATTRIB_SWAP_METHOD        40
#define __DRI_ATTRIB_MAX_SWAP_INTERVAL      41
#define __DRI_ATTRIB_MIN_SWAP_INTERVAL      42
#define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB    43
#define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA   44
#define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
#define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS    46
#define __DRI_ATTRIB_YINVERTED          47

/* __DRI_ATTRIB_RENDER_TYPE */
#define __DRI_ATTRIB_RGBA_BIT           0x01    
#define __DRI_ATTRIB_COLOR_INDEX_BIT        0x02
#define __DRI_ATTRIB_LUMINANCE_BIT      0x04

/* __DRI_ATTRIB_CONFIG_CAVEAT */
#define __DRI_ATTRIB_SLOW_BIT           0x01
#define __DRI_ATTRIB_NON_CONFORMANT_CONFIG  0x02

/* __DRI_ATTRIB_TRANSPARENT_TYPE */
#define __DRI_ATTRIB_TRANSPARENT_RGB        0x00
#define __DRI_ATTRIB_TRANSPARENT_INDEX      0x01

/* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS  */
#define __DRI_ATTRIB_TEXTURE_1D_BIT     0x01
#define __DRI_ATTRIB_TEXTURE_2D_BIT     0x02
#define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT  0x04

#define __DRI_CORE "DRI_Core"
#define __DRI_CORE_VERSION 1

struct __DRIcoreExtensionRec {
    __DRIextension base;

    __DRIscreen *(*createNewScreen)(int screen, int fd,
                    unsigned int sarea_handle,
                    const __DRIextension **extensions,
                    const __DRIconfig ***driverConfigs,
                    void *loaderPrivate);

    void (*destroyScreen)(__DRIscreen *screen);

    const __DRIextension **(*getExtensions)(__DRIscreen *screen);

    int (*getConfigAttrib)(const __DRIconfig *config,
               unsigned int attrib,
               unsigned int *value);

    int (*indexConfigAttrib)(const __DRIconfig *config, int index,
                 unsigned int *attrib, unsigned int *value);

    __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
                    const __DRIconfig *config,
                    unsigned int drawable_id,
                    unsigned int head,
                    void *loaderPrivate);

    void (*destroyDrawable)(__DRIdrawable *drawable);

    void (*swapBuffers)(__DRIdrawable *drawable);

    __DRIcontext *(*createNewContext)(__DRIscreen *screen,
                      const __DRIconfig *config,
                      __DRIcontext *shared,
                      void *loaderPrivate);

    int (*copyContext)(__DRIcontext *dest,
               __DRIcontext *src,
               unsigned long mask);

    void (*destroyContext)(__DRIcontext *context);

    int (*bindContext)(__DRIcontext *ctx,
               __DRIdrawable *pdraw,
               __DRIdrawable *pread);

    int (*unbindContext)(__DRIcontext *ctx);
};

struct __DRIversionRec {
    int    major;        
    int    minor;        
    int    patch;        
};

struct __DRIframebufferRec {
    unsigned char *base;    
    int size;               
    int stride;             
    int width;              
    int height;             
    int dev_priv_size;      
    void *dev_priv;         
};


#define __DRI_LEGACY "DRI_Legacy"
#define __DRI_LEGACY_VERSION 1

struct __DRIlegacyExtensionRec {
    __DRIextension base;

    __DRIscreen *(*createNewScreen)(int screen,
                    const __DRIversion *ddx_version,
                    const __DRIversion *dri_version,
                    const __DRIversion *drm_version,
                    const __DRIframebuffer *frame_buffer,
                    void *pSAREA, int fd, 
                    const __DRIextension **extensions,
                    const __DRIconfig ***driver_configs,
                    void *loaderPrivate);

    __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
                    const __DRIconfig *config,
                    drm_drawable_t hwDrawable,
                    int renderType, const int *attrs,
                    void *loaderPrivate);

    __DRIcontext *(*createNewContext)(__DRIscreen *screen,
                      const __DRIconfig *config,
                      int render_type,
                      __DRIcontext *shared,
                      drm_context_t hwContext,
                      void *loaderPrivate);
};

#define __DRI_SWRAST "DRI_SWRast"
#define __DRI_SWRAST_VERSION 1

struct __DRIswrastExtensionRec {
    __DRIextension base;

    __DRIscreen *(*createNewScreen)(int screen,
                    const __DRIextension **extensions,
                    const __DRIconfig ***driver_configs,
                    void *loaderPrivate);

    __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
                    const __DRIconfig *config,
                    void *loaderPrivate);
};

#define __DRI_BUFFER_FRONT_LEFT     0
#define __DRI_BUFFER_BACK_LEFT      1
#define __DRI_BUFFER_FRONT_RIGHT    2
#define __DRI_BUFFER_BACK_RIGHT     3
#define __DRI_BUFFER_DEPTH      4
#define __DRI_BUFFER_STENCIL        5
#define __DRI_BUFFER_ACCUM      6
#define __DRI_BUFFER_FAKE_FRONT_LEFT    7
#define __DRI_BUFFER_FAKE_FRONT_RIGHT   8

struct __DRIbufferRec {
    unsigned int attachment;
    unsigned int name;
    unsigned int pitch;
    unsigned int cpp;
    unsigned int flags;
};

#define __DRI_DRI2_LOADER "DRI_DRI2Loader"
#define __DRI_DRI2_LOADER_VERSION 1
struct __DRIdri2LoaderExtensionRec {
    __DRIextension base;

    __DRIbuffer *(*getBuffers)(__DRIdrawable *driDrawable,
                   int *width, int *height,
                   unsigned int *attachments, int count,
                   int *out_count, void *loaderPrivate);
};

#define __DRI_DRI2 "DRI_DRI2"
#define __DRI_DRI2_VERSION 1

struct __DRIdri2ExtensionRec {
    __DRIextension base;

    __DRIscreen *(*createNewScreen)(int screen, int fd,
                    const __DRIextension **extensions,
                    const __DRIconfig ***driver_configs,
                    void *loaderPrivate);

    __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
                    const __DRIconfig *config,
                    void *loaderPrivate);

    __DRIcontext *(*createNewContext)(__DRIscreen *screen,
                      const __DRIconfig *config,
                      __DRIcontext *shared,
                      void *loaderPrivate);

};

#endif