ReactOS  0.4.10-dev-348-gbcec1fd
ntgdihdl.h
Go to the documentation of this file.
1 /*
2  * COPYRIGHT: See COPYING in the top level directory
3  * PROJECT: ReactOS Win32 Graphical Subsystem (WIN32K)
4  * FILE: win32ss/include/ntgdihdl.h
5  * PURPOSE: Win32 Shared GDI Handle/Object Types
6  * PROGRAMMER: Alex Ionescu (alex@relsoft.net)
7  */
8 
9 /* INCLUDES ******************************************************************/
10 
11 #ifndef _NTGDIHDL_
12 #define _NTGDIHDL_
13 
14 #include <winddi.h>
15 
16 /* DEFINES *******************************************************************/
17 
18 /* GDI handle table can hold 0x10000 handles */
19 #define GDI_HANDLE_COUNT 0x10000
20 #define GDI_CFONT_MAX 16
21 
22 /* Handle Masks and shifts */
23 #define GDI_HANDLE_INDEX_MASK (GDI_HANDLE_COUNT - 1)
24 #define GDI_HANDLE_TYPE_MASK 0x007f0000
25 #define GDI_HANDLE_BASETYPE_MASK 0x001f0000
26 #define GDI_HANDLE_EXTYPE_MASK 0x00600000
27 #define GDI_HANDLE_STOCK_MASK 0x00800000
28 #define GDI_HANDLE_REUSE_MASK 0xff000000
29 #define GDI_HANDLE_UPPER_MASK (GDI_HANDLE_TYPE_MASK|GDI_HANDLE_STOCK_MASK|GDI_HANDLE_REUSE_MASK)
30 #define GDI_HANDLE_REUSECNT_SHIFT 24
31 #define GDI_HANDLE_BASETYPE_SHIFT 16
32 
33 #define GDI_ENTRY_STOCK_MASK 0x00000080
34 #define GDI_ENTRY_BASETYPE_MASK 0x001f0000
35 #define GDI_ENTRY_UPPER_SHIFT 16
36 
37 /* GDI Entry Flags */
38 #define GDI_ENTRY_UNDELETABLE 1 /* Mark Object as nonremovable */
39 #define GDI_ENTRY_DELETING 2 /* Used when deleting Font Objects */
40 #define GDI_ENTRY_VALIDATE_VIS 4 /* Validating Visible region data */
41 #define GDI_ENTRY_ALLOCATE_LAL 0x80 /* Object Allocated with Look aside List */
42 
49 #define GDI_OBJECT_TYPE_DC 0x00010000
50 #define GDI_OBJECT_TYPE_DD_SURFACE 0x00030000 /* Should be moved away from gdi objects */
51 #define GDI_OBJECT_TYPE_REGION 0x00040000
52 #define GDI_OBJECT_TYPE_BITMAP 0x00050000
53 #define GDI_OBJECT_TYPE_CLIOBJ 0x00060000
54 #define GDI_OBJECT_TYPE_PATH 0x00070000
55 #define GDI_OBJECT_TYPE_PALETTE 0x00080000
56 #define GDI_OBJECT_TYPE_COLORSPACE 0x00090000
57 #define GDI_OBJECT_TYPE_FONT 0x000a0000
58 
59 #define GDI_OBJECT_TYPE_BRUSH 0x00100000
60 #define GDI_OBJECT_TYPE_DD_VIDEOPORT 0x00120000 /* Should be moved away from gdi objects */
61 #define GDI_OBJECT_TYPE_DD_MOTIONCOMP 0x00140000 /* Should be moved away from gdi objects */
62 #define GDI_OBJECT_TYPE_ENUMFONT 0x00160000
63 #define GDI_OBJECT_TYPE_DRIVEROBJ 0x001C0000
64 
65 /* Confrim on XP value is taken from NtGdiCreateDirectDrawObject */
66 #define GDI_OBJECT_TYPE_DIRECTDRAW 0x00200000
67 
68 /* Following object types are derived types from the above base types
69  use 0x001f0000 as mask to get the base type */
70 #define GDI_OBJECT_TYPE_EMF 0x00210000
71 
72 #define GDI_OBJECT_TYPE_METAFILE 0x00260000
73 #define GDI_OBJECT_TYPE_ENHMETAFILE 0x00460000
74 #define GDI_OBJECT_TYPE_PEN 0x00300000
75 #define GDI_OBJECT_TYPE_EXTPEN 0x00500000
76 #define GDI_OBJECT_TYPE_METADC 0x00660000
77 /*#define GDI_OBJECT_TYPE_DD_PALETTE 0x00630000 unused at the moment, other value required */
78 /*#define GDI_OBJECT_TYPE_DD_CLIPPER 0x00640000 unused at the moment, other value required */
79 
80 /* Following object types made up for ROS */
81 #define GDI_OBJECT_TYPE_DONTCARE 0x007f0000
82 
83 #define GDI_OBJECT_TYPE_SILENT 0x80000000
84 
86 /* Handle macros */
87 #define GDI_HANDLE_CREATE(i, t) \
88  ((HANDLE)(((i) & GDI_HANDLE_INDEX_MASK) | ((t) & GDI_HANDLE_TYPE_MASK)))
89 
90 #define GDI_HANDLE_GET_INDEX(h) \
91  (((ULONG_PTR)(h)) & GDI_HANDLE_INDEX_MASK)
92 
93 #define GDI_HANDLE_GET_TYPE(h) \
94  (((ULONG_PTR)(h)) & GDI_HANDLE_TYPE_MASK)
95 
96 #define GDI_HANDLE_IS_TYPE(h, t) \
97  ((t) == (((ULONG_PTR)(h)) & GDI_HANDLE_TYPE_MASK))
98 
99 #define GDI_HANDLE_IS_STOCKOBJ(h) \
100  (0 != (((ULONG_PTR)(h)) & GDI_HANDLE_STOCK_MASK))
101 
102 #define GDI_HANDLE_SET_STOCKOBJ(h) \
103  ((h) = (HANDLE)(((ULONG_PTR)(h)) | GDI_HANDLE_STOCK_MASK))
104 
105 #define GDI_HANDLE_GET_UPPER(h) \
106  (((ULONG_PTR)(h)) & GDI_HANDLE_UPPER_MASK)
107 
108 #define GDI_HANDLE_GET_REUSECNT(h) \
109  (((ULONG_PTR)(h)) >> GDI_HANDLE_REUSECNT_SHIFT)
110 
111 #define GDI_OBJECT_GET_TYPE_INDEX(t) \
112  ((t & GDI_HANDLE_BASETYPE_MASK) >> GDI_HANDLE_BASETYPE_SHIFT)
113 
114 /* Gdi Object Handle Managment Pid lock masking sets. */
115 /* Ref: used with DxEngSetDCOwner */
116 #define GDI_OBJ_HMGR_PUBLIC 0 /* Public owner, Open access? */
117 #define GDI_OBJ_HMGR_POWNED 0x80000002 /* Set to current owner. */
118 #define GDI_OBJ_HMGR_NONE 0x80000012 /* No owner, Open access? */
119 #define GDI_OBJ_HMGR_RESTRICTED 0x80000022 /* Restricted? */
120 
121 
122 /* DC OBJ Types */
123 #define DC_TYPE_DIRECT 0 /* normal device context */
124 #define DC_TYPE_MEMORY 1 /* memory device context */
125 #define DC_TYPE_INFO 2 /* information context */
126 
127 /* DC OBJ Flags */
128 #define DC_FLAG_DISPLAY 0x0001
129 #define DC_FLAG_DIRECT 0x0002
130 #define DC_FLAG_CANCELLED 0x0004
131 #define DC_FLAG_PERMANENT 0x0008
132 #define DC_FLAG_DIRTY_RAO 0x0010
133 #define DC_FLAG_ACCUM_WMGR 0x0020
134 #define DC_FLAG_ACCUM_APP 0x0040
135 #define DC_FLAG_RESET 0x0080
136 #define DC_FLAG_SYNCHRONIZEACCESS 0x0100
137 #define DC_FLAG_EPSPRINTINGESCAPE 0x0200
138 #define DC_FLAG_TEMPINFODC 0x0400
139 #define DC_FLAG_FULLSCREEN 0x0800
140 #define DC_FLAG_IN_CLONEPDEV 0x1000
141 #define DC_FLAG_REDIRECTION 0x2000
142 #define DC_FLAG_SHAREACCESS 0x4000
143 
144 /* DC_ATTR Dirty Flags */
145 #define DIRTY_FILL 0x00000001
146 #define DIRTY_LINE 0x00000002
147 #define DIRTY_TEXT 0x00000004
148 #define DIRTY_BACKGROUND 0x00000008
149 #define DIRTY_CHARSET 0x00000010
150 #define SLOW_WIDTHS 0x00000020
151 #define DC_CACHED_TM_VALID 0x00000040
152 #define DISPLAY_DC 0x00000080
153 #define DIRTY_PTLCURRENT 0x00000100
154 #define DIRTY_PTFXCURRENT 0x00000200
155 #define DIRTY_STYLESTATE 0x00000400
156 #define DC_PLAYMETAFILE 0x00000800
157 #define DC_BRUSH_DIRTY 0x00001000
158 #define DC_PEN_DIRTY 0x00002000
159 #define DC_DIBSECTION 0x00004000
160 #define DC_LAST_CLIPRGN_VALID 0x00008000
161 #define DC_PRIMARY_DISPLAY 0x00010000
162 #define DC_ICM_NOT_CALIBRATED 0x00020000
163 #define DC_ICM_BRUSH_DIRTY 0x00040000
164 #define DC_ICM_PEN_DIRTY 0x00080000
165 #define DC_ICM_NOT_SET 0x00100000
166 #define DC_MODE_DIRTY 0x00200000
167 #define DC_FONTTEXT_DIRTY 0x00400000
168 
169 /* DC_ATTR LCD Flags */
170 #define LDC_LDC 0x00000001 /* (init) local DC other than a normal DC */
171 #define LDC_EMFLDC 0x00000002 /* Enhance Meta File local DC */
172 #define LDC_SAPCALLBACK 0x00000020
173 #define LDC_INIT_DOCUMENT 0x00000040
174 #define LDC_INIT_PAGE 0x00000080
175 #define LDC_STARTPAGE 0x00000100
176 #define LDC_PLAY_MFDC 0x00000800
177 #define LDC_CLOCKWISE 0x00002000
178 #define LDC_KILL_DOCUMENT 0x00010000
179 #define LDC_META_PRINT 0x00020000
180 #define LDC_INFODC 0x01000000 /* If CreateIC was passed. */
181 #define LDC_DEVCAPS 0x02000000
182 #define LDC_ATENDPAGE 0x10000000
183 
184 /* DC_ATTR Xform Flags */
185 #define METAFILE_TO_WORLD_IDENTITY 0x00000001
186 #define WORLD_TO_PAGE_IDENTITY 0x00000002
187 #define DEVICE_TO_PAGE_INVALID 0x00000008
188 #define DEVICE_TO_WORLD_INVALID 0x00000010
189 #define WORLD_TRANSFORM_SET 0x00000020
190 #define POSITIVE_Y_IS_UP 0x00000040
191 #define INVALIDATE_ATTRIBUTES 0x00000080
192 #define PTOD_EFM11_NEGATIVE 0x00000100
193 #define PTOD_EFM22_NEGATIVE 0x00000200
194 #define ISO_OR_ANISO_MAP_MODE 0x00000400
195 #define PAGE_TO_DEVICE_IDENTITY 0x00000800
196 #define PAGE_TO_DEVICE_SCALE_IDENTITY 0x00001000
197 #define PAGE_XLATE_CHANGED 0x00002000
198 #define PAGE_EXTENTS_CHANGED 0x00004000
199 #define WORLD_XFORM_CHANGED 0x00008000
200 
201 /* BRUSH/RGN_ATTR Flags */
202 #define ATTR_CACHED 0x00000001
203 #define ATTR_TO_BE_DELETED 0x00000002
204 #define ATTR_NEW_COLOR 0x00000004
205 #define ATTR_CANT_SELECT 0x00000008
206 #define ATTR_RGN_VALID 0x00000010
207 #define ATTR_RGN_DIRTY 0x00000020
208 
209 
210 /* TYPES *********************************************************************/
211 
212 typedef struct _GDI_TABLE_ENTRY
213 {
214  PVOID KernelData; /* Points to the kernel mode structure */
215  DWORD ProcessId; /* process id that created the object, 0 for stock objects */
216  union{ /* temp union structure. */
217  LONG Type; /* the first 16 bit is the object type including the stock obj flag, the last 16 bits is just the object type */
218  struct{
219  USHORT FullUnique; /* unique */
220  UCHAR ObjectType; /* objt */
221  UCHAR Flags; /* Flags */
222  };};
223  PVOID UserData; /* pUser Points to the user mode structure, usually NULL though */
225 
226 typedef struct _ENTRY
227 {
228  union _EINFO
229  {
230  struct _BASEOBJECT *pobj;
232  } einfo;
233 
235  {
237  {
238  unsigned Lock:1;
239  unsigned Pid_Shifted:31;
240  } Share;
242  } ObjectOwner;
243 
248 } ENTRY, *PENTRY;
249 
250 /*
251  * User space only structure!
252  */
253 typedef struct __GDI_SHARED_HANDLE_TABLE /* Must match win32k/include/gdiobj.h */
254 {
256  DEVCAPS DevCaps; /* Shared device capabilities. */
257  FLONG flDeviceUniq; /* Device settings uniqueness. */
258  PVOID pvLangPack; /* Lanuage Pack. */
259  CFONT cfPublic[GDI_CFONT_MAX]; /* Public Fonts. */
262 
263 typedef struct _RGN_ATTR
264 {
266  ULONG iComplexity; /* Clipping region's complexity. NULL, SIMPLE & COMPLEXREGION */
269 
270 /* Local DC structure (_DC_ATTR) PVOID pvLDC; */
271 typedef struct _LDC
272 {
276  PVOID pvEmfDC; /* Pointer to ENHMETAFILE structure */
278  ABORTPROC pAbortProc; /* AbortProc for Printing */
280  HANDLE hPrinter; /* Local or Remote Printer driver */
284  HBRUSH BrushColor;
285  HPEN PenColor;
286 } LDC, *PLDC;
287 
288 typedef struct _DC_ATTR
289 {
316  HCOLORSPACE hColorSpace;
348 } DC_ATTR, *PDC_ATTR;
349 
350 typedef struct _BRUSH_ATTR /* Used with pen too. */
351 {
355 
356 typedef struct _FONT_ATTR
357 {
361 
362 
363 #endif
DWORD *typedef PVOID
Definition: winlogon.h:52
BOOL(CALLBACK * ABORTPROC)(HDC, int)
Definition: wingdi.h:2888
struct _FONT_ATTR FONT_ATTR
FLOATOBJ efM22PtoD
Definition: ntgdihdl.h:332
#define HDC
Definition: msvc.h:22
PVOID pvEmfDC
Definition: ntgdihdl.h:276
PVOID UserData
Definition: gdi.h:6
POINTL ptlViewportOrg
Definition: ntgdihdl.h:340
struct _RGN_ATTR RGN_ATTR
PVOID pUser
Definition: ntgdihdl.h:247
PVOID pvLDC
Definition: ntgdihdl.h:290
HPEN PenColor
Definition: ntgdihdl.h:285
FLONG flFontMapper
Definition: ntgdihdl.h:313
struct _RGN_ATTR * PRGN_ATTR
HANDLE hbrush
Definition: ntgdihdl.h:292
LONG lBreakExtra
Definition: ntgdihdl.h:325
BYTE jStretchBltMode
Definition: ntgdihdl.h:307
HANDLE hpen
Definition: ntgdihdl.h:293
UCHAR Objt
Definition: ntgdihdl.h:245
INT iMapMode
Definition: ntgdihdl.h:335
USHORT FullUnique
Definition: ntgdihdl.h:219
DWORD CallBackTick
Definition: ntgdihdl.h:279
HCOLORSPACE hColorSpace
Definition: ntgdihdl.h:316
struct _BASEOBJECT * pobj
Definition: ntgdihdl.h:230
LONG lFillMode
Definition: ntgdihdl.h:311
COLORREF crPenClr
Definition: ntgdihdl.h:300
UCHAR Flags
Definition: ntgdihdl.h:246
LONG lTextExtra
Definition: ntgdihdl.h:323
LONG lRelAbs
Definition: ntgdihdl.h:324
HANDLE hcmXform
Definition: ntgdihdl.h:315
int32_t INT
Definition: typedefs.h:56
ULONG Flags
Definition: ntgdihdl.h:274
DWORD DWORD
Definition: winlogon.h:75
union _ENTRY::_EINFO einfo
ULONG ulBackgroundClr
Definition: ntgdihdl.h:295
#define GDI_HANDLE_COUNT
Definition: ntgdihdl.h:19
struct _FONT_ATTR * PFONT_ATTR
struct _ENTRY ENTRY
Definition: ntgdihdl.h:234
struct _LDC * PLDC
long LONG
Definition: pedump.c:60
PCFONT pCharWidthData
Definition: ntgdihdl.h:359
FLONG AttrFlags
Definition: ntgdihdl.h:352
HANDLE hlfntNew
Definition: ntgdihdl.h:327
PVOID PUMDHPDEV
Definition: ntgdityp.h:246
GDI_TABLE_ENTRY Entries[GDI_HANDLE_COUNT]
Definition: ntgdihdl.h:255
DWORD ProcessId
Definition: ntgdihdl.h:215
FLOATOBJ efDxPtoD
Definition: ntgdihdl.h:333
HDC hDC
Definition: ntgdihdl.h:273
PVOID pvLIcm
Definition: ntgdihdl.h:320
struct __GDI_SHARED_HANDLE_TABLE GDI_SHARED_HANDLE_TABLE
struct _LDC LDC
ULONG AttrFlags
Definition: ntgdihdl.h:265
unsigned long FLONG
Definition: ntbasedef.h:373
struct _DC_ATTR * PDC_ATTR
ULONG ulDirty_
Definition: ntgdihdl.h:291
LONG lIcmMode
Definition: ntgdihdl.h:314
COLORREF crBackgroundClr
Definition: ntgdihdl.h:294
unsigned int BOOL
Definition: ntddk_ex.h:94
FLOAT FLOATOBJ
Definition: winddi.h:677
Definition: matrix.h:43
BYTE jROP2
Definition: ntgdihdl.h:304
struct _ENTRY * PENTRY
COLORREF crBrushClr
Definition: ntgdihdl.h:298
LONG Type
Definition: gdi.h:5
DWORD iCS_CP
Definition: ntgdihdl.h:302
LONG cBreak
Definition: ntgdihdl.h:326
ULONG ulObj
Definition: ntgdihdl.h:241
MATRIX mxWorldToPage
Definition: ntgdihdl.h:330
Definition: ntgdihdl.h:271
INT iType
Definition: ntgdihdl.h:275
Definition: ntgdihdl.h:228
unsigned char UCHAR
Definition: xmlstorage.h:181
LONG lWindowOrgx
Definition: ntgdihdl.h:337
RGN_ATTR VisRectRegion
Definition: ntgdihdl.h:347
BYTE jFillMode
Definition: ntgdihdl.h:306
#define GDI_CFONT_MAX
Definition: ntgdihdl.h:20
FLONG flXform
Definition: ntgdihdl.h:342
SIZEL szlWindowExt
Definition: ntgdihdl.h:339
POINTL ptfxCurrent
Definition: ntgdihdl.h:309
ULONG iComplexity
Definition: ntgdihdl.h:266
MATRIX mxWorldToDevice
Definition: ntgdihdl.h:328
struct _ENTRY::_OBJECTOWNER::_OBJECTOWNER_S Share
HGDIOBJ hFree
Definition: ntgdihdl.h:231
POINTL ptlBrushOrigin
Definition: ntgdihdl.h:346
BOOL bSlowWidths
Definition: ntgdihdl.h:358
ULONG ulPenClr
Definition: ntgdihdl.h:301
BYTE jBkMode
Definition: ntgdihdl.h:305
SIZEL szlVirtualDevicePixel
Definition: ntgdihdl.h:343
unsigned char BYTE
Definition: ntddk_ex.h:96
struct _GDI_TABLE_ENTRY * PGDI_TABLE_ENTRY
unsigned Lock
Definition: ntgdihdl.h:238
Definition: gdi.h:1
Definition: ntgdihdl.h:236
INT IcmPenColor
Definition: ntgdihdl.h:319
UCHAR Flags
Definition: ntgdihdl.h:221
INT IcmBrushColor
Definition: ntgdihdl.h:318
DWORD *typedef HANDLE
Definition: winlogon.h:52
struct __GDI_SHARED_HANDLE_TABLE * PGDI_SHARED_HANDLE_TABLE
LONG lStretchBltMode
Definition: ntgdihdl.h:312
unsigned short USHORT
Definition: pedump.c:61
ULONG ulForegroundClr
Definition: ntgdihdl.h:297
COLORREF lbColor
Definition: ntgdihdl.h:353
ULONG ulBrushClr
Definition: ntgdihdl.h:299
USHORT FullUnique
Definition: ntgdihdl.h:244
struct _GDI_TABLE_ENTRY GDI_TABLE_ENTRY
PVOID KernelData
Definition: gdi.h:3
FLOATOBJ efM11PtoD
Definition: ntgdihdl.h:331
DEVCAPS DevCaps
Definition: ntgdihdl.h:283
UCHAR ObjectType
Definition: ntgdihdl.h:220
FLONG flTextAlign
Definition: ntgdihdl.h:321
LONG lBkMode
Definition: ntgdihdl.h:310
RECTL Rect
Definition: ntgdihdl.h:267
COLORREF crForegroundClr
Definition: ntgdihdl.h:296
FLOATOBJ efDyPtoD
Definition: ntgdihdl.h:334
struct _BRUSH_ATTR * PBRUSH_ATTR
FLONG flIcmFlags
Definition: ntgdihdl.h:317
SIZEL szlVirtualDeviceSize
Definition: ntgdihdl.h:345
SIZEL szlViewportExt
Definition: ntgdihdl.h:341
unsigned int ULONG
Definition: retypes.h:1
unsigned Pid_Shifted
Definition: ntgdihdl.h:239
DWORD dwLayout
Definition: ntgdihdl.h:336
CFONT cfPublic[GDI_CFONT_MAX]
Definition: ntgdihdl.h:259
PVOID pUMPDev
Definition: ntgdihdl.h:281
union _ENTRY::_OBJECTOWNER ObjectOwner
Definition: ntgdihdl.h:226
LPWSTR pwszPort
Definition: ntgdihdl.h:277
MATRIX mxDeviceToWorld
Definition: ntgdihdl.h:329
ABORTPROC pAbortProc
Definition: ntgdihdl.h:278
DWORD COLORREF
Definition: windef.h:290
WCHAR * LPWSTR
Definition: xmlstorage.h:184
struct _BRUSH_ATTR BRUSH_ATTR
POINTL ptlCurrent
Definition: ntgdihdl.h:308
HANDLE hPrinter
Definition: ntgdihdl.h:280
HBRUSH BrushColor
Definition: ntgdihdl.h:284
PUMDHPDEV pUMdhpdev
Definition: ntgdihdl.h:282
POINTL ptlWindowOrg
Definition: ntgdihdl.h:338
LONG lTextAlign
Definition: ntgdihdl.h:322
struct _DC_ATTR DC_ATTR
SIZEL szlVirtualDeviceMm
Definition: ntgdihdl.h:344
INT iGraphicsMode
Definition: ntgdihdl.h:303