wined3d: Support for using auxilliary buffers for offscreen rendering.
[wine] / dlls / wined3d / volume.c
1 /*
2  * IWineD3DVolume implementation
3  *
4  * Copyright 2002-2005 Jason Edmeades
5  * Copyright 2002-2005 Raphael Junqueira
6  * Copyright 2005 Oliver Stieber
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21  */
22
23 #include "config.h"
24 #include "wined3d_private.h"
25
26 WINE_DEFAULT_DEBUG_CHANNEL(d3d);
27 #define GLINFO_LOCATION ((IWineD3DImpl *)(((IWineD3DDeviceImpl *)This->resource.wineD3DDevice)->wineD3D))->gl_info
28
29 /* *******************************************
30    IWineD3DVolume IUnknown parts follow
31    ******************************************* */
32 static HRESULT WINAPI IWineD3DVolumeImpl_QueryInterface(IWineD3DVolume *iface, REFIID riid, LPVOID *ppobj)
33 {
34     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
35     TRACE("(%p)->(%s,%p)\n",This,debugstr_guid(riid),ppobj);
36     if (IsEqualGUID(riid, &IID_IUnknown)
37         || IsEqualGUID(riid, &IID_IWineD3DBase)
38         || IsEqualGUID(riid, &IID_IWineD3DVolume)){
39         IUnknown_AddRef(iface);
40         *ppobj = This;
41         return S_OK;
42     }
43     *ppobj = NULL;
44     return E_NOINTERFACE;
45 }
46
47 static ULONG WINAPI IWineD3DVolumeImpl_AddRef(IWineD3DVolume *iface) {
48     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
49     TRACE("(%p) : AddRef increasing from %d\n", This, This->resource.ref);
50     return InterlockedIncrement(&This->resource.ref);
51 }
52
53 static ULONG WINAPI IWineD3DVolumeImpl_Release(IWineD3DVolume *iface) {
54     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
55     ULONG ref;
56     TRACE("(%p) : Releasing from %d\n", This, This->resource.ref);
57     ref = InterlockedDecrement(&This->resource.ref);
58     if (ref == 0) {
59         IWineD3DResourceImpl_CleanUp((IWineD3DResource *)iface);
60         HeapFree(GetProcessHeap(), 0, This);
61     }
62     return ref;
63 }
64
65 /* ****************************************************
66    IWineD3DVolume IWineD3DResource parts follow
67    **************************************************** */
68 static HRESULT WINAPI IWineD3DVolumeImpl_GetParent(IWineD3DVolume *iface, IUnknown **pParent) {
69     return IWineD3DResourceImpl_GetParent((IWineD3DResource *)iface, pParent);
70 }
71
72 static HRESULT WINAPI IWineD3DVolumeImpl_GetDevice(IWineD3DVolume *iface, IWineD3DDevice** ppDevice) {
73     return IWineD3DResourceImpl_GetDevice((IWineD3DResource *)iface, ppDevice);
74 }
75
76 static HRESULT WINAPI IWineD3DVolumeImpl_SetPrivateData(IWineD3DVolume *iface, REFGUID refguid, CONST void* pData, DWORD SizeOfData, DWORD Flags) {
77     return IWineD3DResourceImpl_SetPrivateData((IWineD3DResource *)iface, refguid, pData, SizeOfData, Flags);
78 }
79
80 static HRESULT WINAPI IWineD3DVolumeImpl_GetPrivateData(IWineD3DVolume *iface, REFGUID  refguid, void* pData, DWORD* pSizeOfData) {
81     return IWineD3DResourceImpl_GetPrivateData((IWineD3DResource *)iface, refguid, pData, pSizeOfData);
82 }
83
84 static HRESULT WINAPI IWineD3DVolumeImpl_FreePrivateData(IWineD3DVolume *iface, REFGUID refguid) {
85     return IWineD3DResourceImpl_FreePrivateData((IWineD3DResource *)iface, refguid);
86 }
87
88 static DWORD WINAPI IWineD3DVolumeImpl_SetPriority(IWineD3DVolume *iface, DWORD PriorityNew) {
89     return IWineD3DResourceImpl_SetPriority((IWineD3DResource *)iface, PriorityNew);
90 }
91
92 static DWORD WINAPI IWineD3DVolumeImpl_GetPriority(IWineD3DVolume *iface) {
93     return IWineD3DResourceImpl_GetPriority((IWineD3DResource *)iface);
94 }
95
96 static void WINAPI IWineD3DVolumeImpl_PreLoad(IWineD3DVolume *iface) {
97     return IWineD3DResourceImpl_PreLoad((IWineD3DResource *)iface);
98 }
99
100 static WINED3DRESOURCETYPE WINAPI IWineD3DVolumeImpl_GetType(IWineD3DVolume *iface) {
101     return IWineD3DResourceImpl_GetType((IWineD3DResource *)iface);
102 }
103
104 /* *******************************************
105    IWineD3DVolume parts follow
106    ******************************************* */
107 static HRESULT WINAPI IWineD3DVolumeImpl_GetContainer(IWineD3DVolume *iface, REFIID riid, void** ppContainer) {
108     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
109
110     TRACE("(This %p, riid %s, ppContainer %p)\n", This, debugstr_guid(riid), ppContainer);
111
112     if (!ppContainer) {
113         ERR("Called without a valid ppContainer.\n");
114     }
115
116     /* Although surfaces can be standalone, volumes can't */
117     if (!This->container) {
118         ERR("Volume without an container. Should not happen.\n");
119     }
120
121     TRACE("Relaying to QueryInterface\n");
122     return IUnknown_QueryInterface(This->container, riid, ppContainer);
123 }
124
125 static HRESULT WINAPI IWineD3DVolumeImpl_GetDesc(IWineD3DVolume *iface, WINED3DVOLUME_DESC* pDesc) {
126     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
127     TRACE("(%p) : copying into %p\n", This, pDesc);
128
129     *(pDesc->Format)  = This->resource.format;
130     *(pDesc->Type)    = This->resource.resourceType;
131     *(pDesc->Usage)   = This->resource.usage;
132     *(pDesc->Pool)    = This->resource.pool;
133     *(pDesc->Size)    = This->resource.size; /* dx8 only */
134     *(pDesc->Width)   = This->currentDesc.Width;
135     *(pDesc->Height)  = This->currentDesc.Height;
136     *(pDesc->Depth)   = This->currentDesc.Depth;
137     return WINED3D_OK;
138 }
139
140 static HRESULT WINAPI IWineD3DVolumeImpl_LockBox(IWineD3DVolume *iface, WINED3DLOCKED_BOX* pLockedVolume, CONST WINED3DBOX* pBox, DWORD Flags) {
141     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
142     FIXME("(%p) : pBox=%p stub\n", This, pBox);
143
144     if(!This->resource.allocatedMemory) {
145         This->resource.allocatedMemory = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, This->resource.size);
146     }
147
148     /* fixme: should we really lock as such? */
149     TRACE("(%p) : box=%p, output pbox=%p, allMem=%p\n", This, pBox, pLockedVolume, This->resource.allocatedMemory);
150
151     pLockedVolume->RowPitch   = This->bytesPerPixel * This->currentDesc.Width;                        /* Bytes / row   */
152     pLockedVolume->SlicePitch = This->bytesPerPixel * This->currentDesc.Width * This->currentDesc.Height;  /* Bytes / slice */
153     if (!pBox) {
154         TRACE("No box supplied - all is ok\n");
155         pLockedVolume->pBits = This->resource.allocatedMemory;
156         This->lockedBox.Left   = 0;
157         This->lockedBox.Top    = 0;
158         This->lockedBox.Front  = 0;
159         This->lockedBox.Right  = This->currentDesc.Width;
160         This->lockedBox.Bottom = This->currentDesc.Height;
161         This->lockedBox.Back   = This->currentDesc.Depth;
162     } else {
163         TRACE("Lock Box (%p) = l %d, t %d, r %d, b %d, fr %d, ba %d\n", pBox, pBox->Left, pBox->Top, pBox->Right, pBox->Bottom, pBox->Front, pBox->Back);
164         pLockedVolume->pBits = This->resource.allocatedMemory +
165           (pLockedVolume->SlicePitch * pBox->Front) + /* FIXME: is front < back or vica versa? */
166           (pLockedVolume->RowPitch * pBox->Top) +
167           (pBox->Left * This->bytesPerPixel);
168         This->lockedBox.Left   = pBox->Left;
169         This->lockedBox.Top    = pBox->Top;
170         This->lockedBox.Front  = pBox->Front;
171         This->lockedBox.Right  = pBox->Right;
172         This->lockedBox.Bottom = pBox->Bottom;
173         This->lockedBox.Back   = pBox->Back;
174     }
175
176     if (Flags & (WINED3DLOCK_NO_DIRTY_UPDATE | WINED3DLOCK_READONLY)) {
177       /* Don't dirtify */
178     } else {
179       /**
180        * Dirtify on lock
181        * as seen in msdn docs
182        */
183       IWineD3DVolume_AddDirtyBox(iface, &This->lockedBox);
184
185       /**  Dirtify Container if needed */
186       if (NULL != This->container) {
187
188         IWineD3DVolumeTexture *cont = (IWineD3DVolumeTexture*) This->container;
189         WINED3DRESOURCETYPE containerType = IWineD3DBaseTexture_GetType((IWineD3DBaseTexture *) cont);
190
191         if (containerType == WINED3DRTYPE_VOLUMETEXTURE) {
192           IWineD3DBaseTextureImpl* pTexture = (IWineD3DBaseTextureImpl*) cont;
193           pTexture->baseTexture.dirty = TRUE;
194         } else {
195           FIXME("Set dirty on container type %d\n", containerType);
196         }
197       }
198     }
199
200     This->locked = TRUE;
201     TRACE("returning memory@%p rpitch(%d) spitch(%d)\n", pLockedVolume->pBits, pLockedVolume->RowPitch, pLockedVolume->SlicePitch);
202     return WINED3D_OK;
203 }
204
205 static HRESULT WINAPI IWineD3DVolumeImpl_UnlockBox(IWineD3DVolume *iface) {
206     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
207     if (!This->locked) {
208       ERR("trying to lock unlocked volume@%p\n", This);
209       return WINED3DERR_INVALIDCALL;
210     }
211     TRACE("(%p) : unlocking volume\n", This);
212     This->locked = FALSE;
213     memset(&This->lockedBox, 0, sizeof(RECT));
214     return WINED3D_OK;
215 }
216
217 /* Internal use functions follow : */
218
219 static HRESULT WINAPI IWineD3DVolumeImpl_CleanDirtyBox(IWineD3DVolume *iface) {
220   IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
221   This->dirty = FALSE;
222   This->lockedBox.Left   = This->currentDesc.Width;
223   This->lockedBox.Top    = This->currentDesc.Height;
224   This->lockedBox.Front  = This->currentDesc.Depth;
225   This->lockedBox.Right  = 0;
226   This->lockedBox.Bottom = 0;
227   This->lockedBox.Back   = 0;
228   return WINED3D_OK;
229 }
230
231 static HRESULT WINAPI IWineD3DVolumeImpl_AddDirtyBox(IWineD3DVolume *iface, CONST WINED3DBOX* pDirtyBox) {
232   IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
233   This->dirty = TRUE;
234    if (NULL != pDirtyBox) {
235     This->lockedBox.Left   = min(This->lockedBox.Left,   pDirtyBox->Left);
236     This->lockedBox.Top    = min(This->lockedBox.Top,    pDirtyBox->Top);
237     This->lockedBox.Front  = min(This->lockedBox.Front,  pDirtyBox->Front);
238     This->lockedBox.Right  = max(This->lockedBox.Right,  pDirtyBox->Right);
239     This->lockedBox.Bottom = max(This->lockedBox.Bottom, pDirtyBox->Bottom);
240     This->lockedBox.Back   = max(This->lockedBox.Back,   pDirtyBox->Back);
241   } else {
242     This->lockedBox.Left   = 0;
243     This->lockedBox.Top    = 0;
244     This->lockedBox.Front  = 0;
245     This->lockedBox.Right  = This->currentDesc.Width;
246     This->lockedBox.Bottom = This->currentDesc.Height;
247     This->lockedBox.Back   = This->currentDesc.Depth;
248   }
249   return WINED3D_OK;
250 }
251
252 static HRESULT WINAPI IWineD3DVolumeImpl_SetContainer(IWineD3DVolume *iface, IWineD3DBase* container) {
253     IWineD3DVolumeImpl *This = (IWineD3DVolumeImpl *)iface;
254
255     TRACE("This %p, container %p\n", This, container);
256
257     /* We can't keep a reference to the container, since the container already keeps a reference to us. */
258
259     TRACE("Setting container to %p from %p\n", container, This->container);
260     This->container = container;
261
262     return WINED3D_OK;
263 }
264
265 static HRESULT WINAPI IWineD3DVolumeImpl_LoadTexture(IWineD3DVolume *iface, GLenum gl_level) {
266     IWineD3DVolumeImpl *This     = (IWineD3DVolumeImpl *)iface;
267     const PixelFormatDesc *formatEntry = getFormatDescEntry(This->resource.format);
268
269     if(GL_SUPPORT(EXT_TEXTURE3D)) {
270         TRACE("Calling glTexImage3D %x level=%d, intfmt=%x, w=%d, h=%d,d=%d, 0=%d, glFmt=%x, glType=%x, Mem=%p\n",
271                 GL_TEXTURE_3D,
272                 gl_level,
273                 formatEntry->glInternal,
274                 This->currentDesc.Width,
275                 This->currentDesc.Height,
276                 This->currentDesc.Depth,
277                 0,
278                 formatEntry->glFormat,
279                 formatEntry->glType,
280                 This->resource.allocatedMemory);
281         GL_EXTCALL(glTexImage3DEXT(GL_TEXTURE_3D,
282                     gl_level,
283                     formatEntry->glInternal,
284                     This->currentDesc.Width,
285                     This->currentDesc.Height,
286                     This->currentDesc.Depth,
287                     0,
288                     formatEntry->glFormat,
289                     formatEntry->glType,
290                     This->resource.allocatedMemory));
291         checkGLcall("glTexImage3D");
292     } else
293         WARN("This OpenGL implementation doesn't support 3D textures\n");
294     
295     return WINED3D_OK;
296
297 }
298
299 const IWineD3DVolumeVtbl IWineD3DVolume_Vtbl =
300 {
301     /* IUnknown */
302     IWineD3DVolumeImpl_QueryInterface,
303     IWineD3DVolumeImpl_AddRef,
304     IWineD3DVolumeImpl_Release,
305     /* IWineD3DResource */
306     IWineD3DVolumeImpl_GetParent,
307     IWineD3DVolumeImpl_GetDevice,
308     IWineD3DVolumeImpl_SetPrivateData,
309     IWineD3DVolumeImpl_GetPrivateData,
310     IWineD3DVolumeImpl_FreePrivateData,
311     IWineD3DVolumeImpl_SetPriority,
312     IWineD3DVolumeImpl_GetPriority,
313     IWineD3DVolumeImpl_PreLoad,
314     IWineD3DVolumeImpl_GetType,
315     /* IWineD3DVolume */
316     IWineD3DVolumeImpl_GetContainer,
317     IWineD3DVolumeImpl_GetDesc,
318     IWineD3DVolumeImpl_LockBox,
319     IWineD3DVolumeImpl_UnlockBox,
320     /* Internal interface */
321     IWineD3DVolumeImpl_AddDirtyBox,
322     IWineD3DVolumeImpl_CleanDirtyBox,
323     IWineD3DVolumeImpl_LoadTexture,
324     IWineD3DVolumeImpl_SetContainer
325 };