Tizen 2.0 Release
[profile/ivi/osmesa.git] / src / mesa / drivers / dri / intel / intel_regions.h
1 /**************************************************************************
2  * 
3  * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
4  * All Rights Reserved.
5  * 
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  * 
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  * 
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  * 
26  **************************************************************************/
27
28 #ifndef INTEL_REGIONS_H
29 #define INTEL_REGIONS_H
30
31 /** @file intel_regions.h
32  *
33  * Structure definitions and prototypes for intel_region handling,
34  * which is the basic structure for rectangular collections of pixels
35  * stored in a drm_intel_bo.
36  */
37
38 #include <xf86drm.h>
39
40 #include "main/mtypes.h"
41 #include "intel_bufmgr.h"
42
43 struct intel_context;
44 struct intel_buffer_object;
45
46 /**
47  * A layer on top of the bufmgr buffers that adds a few useful things:
48  *
49  * - Refcounting for local buffer references.
50  * - Refcounting for buffer maps
51  * - Buffer dimensions - pitch and height.
52  * - Blitter commands for copying 2D regions between buffers. (really???)
53  */
54 struct intel_region
55 {
56    drm_intel_bo *buffer;  /**< buffer manager's buffer */
57    GLuint refcount; /**< Reference count for region */
58    GLuint cpp;      /**< bytes per pixel */
59    GLuint width;    /**< in pixels */
60    GLuint height;   /**< in pixels */
61    GLuint pitch;    /**< in pixels */
62    GLubyte *map;    /**< only non-NULL when region is actually mapped */
63    GLuint map_refcount;  /**< Reference count for mapping */
64
65    uint32_t tiling; /**< Which tiling mode the region is in */
66    struct intel_buffer_object *pbo;     /* zero-copy uploads */
67
68    uint32_t name; /**< Global name for the bo */
69    struct intel_screen *screen;
70 };
71
72
73 /* Allocate a refcounted region.  Pointers to regions should only be
74  * copied by calling intel_reference_region().
75  */
76 struct intel_region *intel_region_alloc(struct intel_screen *screen,
77                                         uint32_t tiling,
78                                         GLuint cpp, GLuint width,
79                                         GLuint height,
80                                         GLboolean expect_accelerated_upload);
81
82 struct intel_region *
83 intel_region_alloc_for_handle(struct intel_screen *screen,
84                               GLuint cpp,
85                               GLuint width, GLuint height, GLuint pitch,
86                               unsigned int handle, const char *name);
87
88 GLboolean
89 intel_region_flink(struct intel_region *region, uint32_t *name);
90
91 void intel_region_reference(struct intel_region **dst,
92                             struct intel_region *src);
93
94 void intel_region_release(struct intel_region **ib);
95
96 void intel_recreate_static_regions(struct intel_context *intel);
97
98 /* Map/unmap regions.  This is refcounted also: 
99  */
100 GLubyte *intel_region_map(struct intel_context *intel,
101                           struct intel_region *ib);
102
103 void intel_region_unmap(struct intel_context *intel, struct intel_region *ib);
104
105
106 /* Upload data to a rectangular sub-region
107  */
108 void intel_region_data(struct intel_context *intel,
109                        struct intel_region *dest,
110                        GLuint dest_offset,
111                        GLuint destx, GLuint desty,
112                        const void *src, GLuint src_stride,
113                        GLuint srcx, GLuint srcy, GLuint width, GLuint height);
114
115 /* Copy rectangular sub-regions
116  */
117 GLboolean
118 intel_region_copy(struct intel_context *intel,
119                   struct intel_region *dest,
120                   GLuint dest_offset,
121                   GLuint destx, GLuint desty,
122                   struct intel_region *src,
123                   GLuint src_offset,
124                   GLuint srcx, GLuint srcy, GLuint width, GLuint height,
125                   GLboolean flip,
126                   GLenum logicop);
127
128 /* Helpers for zerocopy uploads, particularly texture image uploads:
129  */
130 void intel_region_attach_pbo(struct intel_context *intel,
131                              struct intel_region *region,
132                              struct intel_buffer_object *pbo);
133 void intel_region_release_pbo(struct intel_context *intel,
134                               struct intel_region *region);
135 void intel_region_cow(struct intel_context *intel,
136                       struct intel_region *region);
137
138 drm_intel_bo *intel_region_buffer(struct intel_context *intel,
139                                   struct intel_region *region,
140                                   GLuint flag);
141
142 void _mesa_copy_rect(GLubyte * dst,
143                 GLuint cpp,
144                 GLuint dst_pitch,
145                 GLuint dst_x,
146                 GLuint dst_y,
147                 GLuint width,
148                 GLuint height,
149                 const GLubyte * src,
150                 GLuint src_pitch, GLuint src_x, GLuint src_y);
151
152 struct __DRIimageRec {
153    struct intel_region *region;
154    GLenum internal_format;
155    GLuint format;
156    GLenum data_type;
157    void *data;
158 };
159
160 #endif