2 * IWineD3DCubeTexture implementation
4 * Copyright 2002-2005 Jason Edmeades
5 * Copyright 2002-2005 Raphael Junqueira
6 * Copyright 2005 Oliver Stieber
7 * Copyright 2007-2008 Stefan Dösinger for CodeWeavers
8 * Copyright 2009-2010 Henri Verbeet for CodeWeavers
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include "wined3d_private.h"
28 WINE_DEFAULT_DEBUG_CHANNEL(d3d_texture);
30 /* Do not call while under the GL lock. */
31 static void cubetexture_internal_preload(IWineD3DBaseTexture *iface, enum WINED3DSRGB srgb)
33 /* Override the IWineD3DResource Preload method. */
34 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
35 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
36 IWineD3DDeviceImpl *device = This->resource.device;
37 struct wined3d_context *context = NULL;
49 cubetexture_internal_preload(iface, SRGB_RGB);
57 srgb_mode = This->baseTexture.is_srgb;
60 dirty = srgb_mode ? &This->baseTexture.texture_srgb.dirty : &This->baseTexture.texture_rgb.dirty;
62 TRACE("(%p) : About to load texture: dirtified(%u).\n", This, *dirty);
64 /* We only have to activate a context for gl when we're not drawing.
65 * In most cases PreLoad will be called during draw and a context was
66 * activated at the beginning of drawPrimitive. */
67 if (!device->isInDraw)
69 /* No danger of recursive calls, context_acquire() sets isInDraw to true
70 * when loading offscreen render targets into their texture. */
71 context = context_acquire(device, NULL);
74 if (This->resource.format->id == WINED3DFMT_P8_UINT
75 || This->resource.format->id == WINED3DFMT_P8_UINT_A8_UNORM)
77 for (i = 0; i < sub_count; ++i)
79 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
81 if (palette9_changed(surface))
83 TRACE("Reloading surface %p because the d3d8/9 palette was changed.\n", surface);
84 /* TODO: This is not necessarily needed with hw palettized texture support. */
85 surface_load_location(surface, SFLAG_INSYSMEM, NULL);
86 /* Make sure the texture is reloaded because of the palette change,
87 * this kills performance though :( */
88 surface_modify_location(surface, SFLAG_INTEXTURE, FALSE);
93 /* If the texture is marked dirty or the srgb sampler setting has changed
94 * since the last load then reload the surfaces. */
97 for (i = 0; i < sub_count; ++i)
99 IWineD3DSurface_LoadTexture((IWineD3DSurface *)This->baseTexture.sub_resources[i], srgb_mode);
104 TRACE("(%p) Texture not dirty, nothing to do.\n" , iface);
107 /* No longer dirty. */
110 if (context) context_release(context);
113 static void cubetexture_cleanup(IWineD3DCubeTextureImpl *This)
115 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
118 TRACE("(%p) : Cleaning up.\n", This);
120 for (i = 0; i < sub_count; ++i)
122 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
126 /* Clean out the texture name we gave to the surface so that the
127 * surface doesn't try and release it. */
128 surface_set_texture_name(surface, 0, TRUE);
129 surface_set_texture_name(surface, 0, FALSE);
130 surface_set_texture_target(surface, 0);
131 surface_set_container(surface, WINED3D_CONTAINER_NONE, NULL);
132 IWineD3DSurface_Release((IWineD3DSurface *)surface);
135 basetexture_cleanup((IWineD3DBaseTexture *)This);
138 /* *******************************************
139 IWineD3DCubeTexture IUnknown parts follow
140 ******************************************* */
142 static HRESULT WINAPI IWineD3DCubeTextureImpl_QueryInterface(IWineD3DCubeTexture *iface, REFIID riid, LPVOID *ppobj)
144 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
145 TRACE("(%p)->(%s,%p)\n",This,debugstr_guid(riid),ppobj);
146 if (IsEqualGUID(riid, &IID_IUnknown)
147 || IsEqualGUID(riid, &IID_IWineD3DBase)
148 || IsEqualGUID(riid, &IID_IWineD3DResource)
149 || IsEqualGUID(riid, &IID_IWineD3DBaseTexture)
150 || IsEqualGUID(riid, &IID_IWineD3DCubeTexture)) {
151 IUnknown_AddRef(iface);
156 return E_NOINTERFACE;
159 static ULONG WINAPI IWineD3DCubeTextureImpl_AddRef(IWineD3DCubeTexture *iface) {
160 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
161 TRACE("(%p) : AddRef increasing from %d\n", This, This->resource.ref);
162 return InterlockedIncrement(&This->resource.ref);
165 /* Do not call while under the GL lock. */
166 static ULONG WINAPI IWineD3DCubeTextureImpl_Release(IWineD3DCubeTexture *iface) {
167 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
169 TRACE("(%p) : Releasing from %d\n", This, This->resource.ref);
170 ref = InterlockedDecrement(&This->resource.ref);
173 cubetexture_cleanup(This);
174 This->resource.parent_ops->wined3d_object_destroyed(This->resource.parent);
175 HeapFree(GetProcessHeap(), 0, This);
180 /* ****************************************************
181 IWineD3DCubeTexture IWineD3DResource parts follow
182 **************************************************** */
183 static HRESULT WINAPI IWineD3DCubeTextureImpl_SetPrivateData(IWineD3DCubeTexture *iface,
184 REFGUID riid, const void *data, DWORD data_size, DWORD flags)
186 return resource_set_private_data((IWineD3DResource *)iface, riid, data, data_size, flags);
189 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetPrivateData(IWineD3DCubeTexture *iface, REFGUID refguid, void* pData, DWORD* pSizeOfData) {
190 return resource_get_private_data((IWineD3DResource *)iface, refguid, pData, pSizeOfData);
193 static HRESULT WINAPI IWineD3DCubeTextureImpl_FreePrivateData(IWineD3DCubeTexture *iface, REFGUID refguid) {
194 return resource_free_private_data((IWineD3DResource *)iface, refguid);
197 static DWORD WINAPI IWineD3DCubeTextureImpl_SetPriority(IWineD3DCubeTexture *iface, DWORD PriorityNew) {
198 return resource_set_priority((IWineD3DResource *)iface, PriorityNew);
201 static DWORD WINAPI IWineD3DCubeTextureImpl_GetPriority(IWineD3DCubeTexture *iface) {
202 return resource_get_priority((IWineD3DResource *)iface);
205 /* Do not call while under the GL lock. */
206 static void WINAPI IWineD3DCubeTextureImpl_PreLoad(IWineD3DCubeTexture *iface) {
207 cubetexture_internal_preload((IWineD3DBaseTexture *) iface, SRGB_ANY);
210 /* Do not call while under the GL lock. */
211 static void WINAPI IWineD3DCubeTextureImpl_UnLoad(IWineD3DCubeTexture *iface)
213 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
214 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
217 TRACE("iface %p.\n", iface);
219 /* Unload all the surfaces and reset the texture name. If UnLoad was called on the
220 * surface before, this one will be a NOP and vice versa. Unloading an unloaded
221 * surface is fine. */
223 for (i = 0; i < sub_count; ++i)
225 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
227 IWineD3DSurface_UnLoad((IWineD3DSurface *)surface);
228 surface_set_texture_name(surface, 0, TRUE);
229 surface_set_texture_name(surface, 0, FALSE);
232 basetexture_unload((IWineD3DBaseTexture *)iface);
235 static WINED3DRESOURCETYPE WINAPI IWineD3DCubeTextureImpl_GetType(IWineD3DCubeTexture *iface) {
236 return resource_get_type((IWineD3DResource *)iface);
239 static void * WINAPI IWineD3DCubeTextureImpl_GetParent(IWineD3DCubeTexture *iface)
241 TRACE("iface %p.\n", iface);
243 return ((IWineD3DCubeTextureImpl *)iface)->resource.parent;
246 /* ******************************************************
247 IWineD3DCubeTexture IWineD3DBaseTexture parts follow
248 ****************************************************** */
249 static DWORD WINAPI IWineD3DCubeTextureImpl_SetLOD(IWineD3DCubeTexture *iface, DWORD LODNew) {
250 return basetexture_set_lod((IWineD3DBaseTexture *)iface, LODNew);
253 static DWORD WINAPI IWineD3DCubeTextureImpl_GetLOD(IWineD3DCubeTexture *iface) {
254 return basetexture_get_lod((IWineD3DBaseTexture *)iface);
257 static DWORD WINAPI IWineD3DCubeTextureImpl_GetLevelCount(IWineD3DCubeTexture *iface) {
258 return basetexture_get_level_count((IWineD3DBaseTexture *)iface);
261 static HRESULT WINAPI IWineD3DCubeTextureImpl_SetAutoGenFilterType(IWineD3DCubeTexture *iface, WINED3DTEXTUREFILTERTYPE FilterType) {
262 return basetexture_set_autogen_filter_type((IWineD3DBaseTexture *)iface, FilterType);
265 static WINED3DTEXTUREFILTERTYPE WINAPI IWineD3DCubeTextureImpl_GetAutoGenFilterType(IWineD3DCubeTexture *iface) {
266 return basetexture_get_autogen_filter_type((IWineD3DBaseTexture *)iface);
269 static void WINAPI IWineD3DCubeTextureImpl_GenerateMipSubLevels(IWineD3DCubeTexture *iface) {
270 basetexture_generate_mipmaps((IWineD3DBaseTexture *)iface);
273 /* Internal function, No d3d mapping */
274 static BOOL WINAPI IWineD3DCubeTextureImpl_SetDirty(IWineD3DCubeTexture *iface, BOOL dirty) {
275 return basetexture_set_dirty((IWineD3DBaseTexture *)iface, dirty);
278 /* Internal function, No d3d mapping */
279 static BOOL WINAPI IWineD3DCubeTextureImpl_GetDirty(IWineD3DCubeTexture *iface) {
280 return basetexture_get_dirty((IWineD3DBaseTexture *)iface);
283 /* Context activation is done by the caller. */
284 static HRESULT WINAPI IWineD3DCubeTextureImpl_BindTexture(IWineD3DCubeTexture *iface, BOOL srgb) {
285 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
286 BOOL set_gl_texture_desc;
289 TRACE("(%p) : relay to BaseTexture\n", This);
291 hr = basetexture_bind((IWineD3DBaseTexture *)iface, srgb, &set_gl_texture_desc);
292 if (set_gl_texture_desc && SUCCEEDED(hr))
294 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
297 for (i = 0; i < sub_count; ++i)
299 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
301 if (This->baseTexture.is_srgb)
302 surface_set_texture_name(surface, This->baseTexture.texture_srgb.name, TRUE);
304 surface_set_texture_name(surface, This->baseTexture.texture_rgb.name, FALSE);
311 static BOOL WINAPI IWineD3DCubeTextureImpl_IsCondNP2(IWineD3DCubeTexture *iface)
313 TRACE("iface %p.\n", iface);
318 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetLevelDesc(IWineD3DCubeTexture *iface,
319 UINT sub_resource_idx, WINED3DSURFACE_DESC *desc)
321 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
322 IWineD3DSurface *surface;
324 TRACE("iface %p, sub_resource_idx %u, desc %p.\n", iface, sub_resource_idx, desc);
326 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
328 WARN("Failed to get sub-resource.\n");
329 return WINED3DERR_INVALIDCALL;
332 IWineD3DSurface_GetDesc(surface, desc);
337 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetCubeMapSurface(IWineD3DCubeTexture *iface,
338 UINT sub_resource_idx, IWineD3DSurface **surface)
340 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
343 TRACE("iface %p, sub_resource_idx %u, surface %p.\n",
344 iface, sub_resource_idx, surface);
346 if (!(s = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
348 WARN("Failed to get sub-resource.\n");
349 return WINED3DERR_INVALIDCALL;
352 IWineD3DSurface_AddRef(s);
355 TRACE("Returning surface %p.\n", *surface);
360 static HRESULT WINAPI IWineD3DCubeTextureImpl_Map(IWineD3DCubeTexture *iface,
361 UINT sub_resource_idx, WINED3DLOCKED_RECT *locked_rect, const RECT *rect, DWORD flags)
363 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
364 IWineD3DSurface *surface;
366 TRACE("iface %p, sub_resource_idx %u, locked_rect %p, rect %s, flags %#x.\n",
367 iface, sub_resource_idx, locked_rect, wine_dbgstr_rect(rect), flags);
369 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
371 WARN("Failed to get sub-resource.\n");
372 return WINED3DERR_INVALIDCALL;
375 return IWineD3DSurface_Map(surface, locked_rect, rect, flags);
378 static HRESULT WINAPI IWineD3DCubeTextureImpl_Unmap(IWineD3DCubeTexture *iface,
379 UINT sub_resource_idx)
381 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
382 IWineD3DSurface *surface;
384 TRACE("iface %p, sub_resource_idx %u.\n",
385 iface, sub_resource_idx);
387 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
389 WARN("Failed to get sub-resource.\n");
390 return WINED3DERR_INVALIDCALL;
393 return IWineD3DSurface_Unmap(surface);
396 static HRESULT WINAPI IWineD3DCubeTextureImpl_AddDirtyRect(IWineD3DCubeTexture *iface,
397 WINED3DCUBEMAP_FACES face, const RECT *dirty_rect)
399 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
400 UINT sub_resource_idx = face * texture->baseTexture.level_count;
401 IWineD3DSurfaceImpl *surface;
403 TRACE("iface %p, face %u, dirty_rect %s.\n",
404 iface, face, wine_dbgstr_rect(dirty_rect));
406 if (!(surface = (IWineD3DSurfaceImpl *)basetexture_get_sub_resource(texture, sub_resource_idx)))
408 WARN("Failed to get sub-resource.\n");
409 return WINED3DERR_INVALIDCALL;
412 texture->baseTexture.texture_rgb.dirty = TRUE;
413 texture->baseTexture.texture_srgb.dirty = TRUE;
414 surface_add_dirty_rect(surface, dirty_rect);
419 static const IWineD3DCubeTextureVtbl IWineD3DCubeTexture_Vtbl =
422 IWineD3DCubeTextureImpl_QueryInterface,
423 IWineD3DCubeTextureImpl_AddRef,
424 IWineD3DCubeTextureImpl_Release,
425 /* IWineD3DResource */
426 IWineD3DCubeTextureImpl_GetParent,
427 IWineD3DCubeTextureImpl_SetPrivateData,
428 IWineD3DCubeTextureImpl_GetPrivateData,
429 IWineD3DCubeTextureImpl_FreePrivateData,
430 IWineD3DCubeTextureImpl_SetPriority,
431 IWineD3DCubeTextureImpl_GetPriority,
432 IWineD3DCubeTextureImpl_PreLoad,
433 IWineD3DCubeTextureImpl_UnLoad,
434 IWineD3DCubeTextureImpl_GetType,
435 /* IWineD3DBaseTexture */
436 IWineD3DCubeTextureImpl_SetLOD,
437 IWineD3DCubeTextureImpl_GetLOD,
438 IWineD3DCubeTextureImpl_GetLevelCount,
439 IWineD3DCubeTextureImpl_SetAutoGenFilterType,
440 IWineD3DCubeTextureImpl_GetAutoGenFilterType,
441 IWineD3DCubeTextureImpl_GenerateMipSubLevels,
442 IWineD3DCubeTextureImpl_SetDirty,
443 IWineD3DCubeTextureImpl_GetDirty,
444 IWineD3DCubeTextureImpl_BindTexture,
445 IWineD3DCubeTextureImpl_IsCondNP2,
446 /* IWineD3DCubeTexture */
447 IWineD3DCubeTextureImpl_GetLevelDesc,
448 IWineD3DCubeTextureImpl_GetCubeMapSurface,
449 IWineD3DCubeTextureImpl_Map,
450 IWineD3DCubeTextureImpl_Unmap,
451 IWineD3DCubeTextureImpl_AddDirtyRect
454 HRESULT cubetexture_init(IWineD3DCubeTextureImpl *texture, UINT edge_length, UINT levels,
455 IWineD3DDeviceImpl *device, DWORD usage, enum wined3d_format_id format_id, WINED3DPOOL pool,
456 void *parent, const struct wined3d_parent_ops *parent_ops)
458 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
459 const struct wined3d_format *format = wined3d_get_format(gl_info, format_id);
460 UINT pow2_edge_length;
465 /* TODO: It should only be possible to create textures for formats
466 * that are reported as supported. */
467 if (WINED3DFMT_UNKNOWN >= format_id)
469 WARN("(%p) : Texture cannot be created with a format of WINED3DFMT_UNKNOWN.\n", texture);
470 return WINED3DERR_INVALIDCALL;
473 if (!gl_info->supported[ARB_TEXTURE_CUBE_MAP] && pool != WINED3DPOOL_SCRATCH)
475 WARN("(%p) : Tried to create not supported cube texture.\n", texture);
476 return WINED3DERR_INVALIDCALL;
479 /* Calculate levels for mip mapping */
480 if (usage & WINED3DUSAGE_AUTOGENMIPMAP)
482 if (!gl_info->supported[SGIS_GENERATE_MIPMAP])
484 WARN("No mipmap generation support, returning D3DERR_INVALIDCALL.\n");
485 return WINED3DERR_INVALIDCALL;
490 WARN("D3DUSAGE_AUTOGENMIPMAP is set, and level count > 1, returning D3DERR_INVALIDCALL.\n");
491 return WINED3DERR_INVALIDCALL;
498 levels = wined3d_log2i(edge_length) + 1;
499 TRACE("Calculated levels = %u.\n", levels);
502 texture->lpVtbl = &IWineD3DCubeTexture_Vtbl;
504 hr = basetexture_init((IWineD3DBaseTextureImpl *)texture, 6, levels,
505 WINED3DRTYPE_CUBETEXTURE, device, usage, format, pool, parent, parent_ops);
508 WARN("Failed to initialize basetexture, returning %#x\n", hr);
512 /* Find the nearest pow2 match. */
513 pow2_edge_length = 1;
514 while (pow2_edge_length < edge_length) pow2_edge_length <<= 1;
516 if (gl_info->supported[ARB_TEXTURE_NON_POWER_OF_TWO] || (edge_length == pow2_edge_length))
518 /* Precalculated scaling for 'faked' non power of two texture coords. */
519 texture->baseTexture.pow2Matrix[0] = 1.0f;
520 texture->baseTexture.pow2Matrix[5] = 1.0f;
521 texture->baseTexture.pow2Matrix[10] = 1.0f;
522 texture->baseTexture.pow2Matrix[15] = 1.0f;
526 /* Precalculated scaling for 'faked' non power of two texture coords. */
527 texture->baseTexture.pow2Matrix[0] = ((float)edge_length) / ((float)pow2_edge_length);
528 texture->baseTexture.pow2Matrix[5] = ((float)edge_length) / ((float)pow2_edge_length);
529 texture->baseTexture.pow2Matrix[10] = ((float)edge_length) / ((float)pow2_edge_length);
530 texture->baseTexture.pow2Matrix[15] = 1.0f;
531 texture->baseTexture.pow2Matrix_identity = FALSE;
533 texture->baseTexture.target = GL_TEXTURE_CUBE_MAP_ARB;
535 /* Generate all the surfaces. */
537 for (i = 0; i < texture->baseTexture.level_count; ++i)
539 /* Create the 6 faces. */
540 for (j = 0; j < 6; ++j)
542 static const GLenum cube_targets[6] =
544 GL_TEXTURE_CUBE_MAP_POSITIVE_X_ARB,
545 GL_TEXTURE_CUBE_MAP_NEGATIVE_X_ARB,
546 GL_TEXTURE_CUBE_MAP_POSITIVE_Y_ARB,
547 GL_TEXTURE_CUBE_MAP_NEGATIVE_Y_ARB,
548 GL_TEXTURE_CUBE_MAP_POSITIVE_Z_ARB,
549 GL_TEXTURE_CUBE_MAP_NEGATIVE_Z_ARB,
551 UINT idx = j * texture->baseTexture.level_count + i;
552 IWineD3DSurface *surface;
554 hr = IWineD3DDeviceParent_CreateSurface(device->device_parent, parent, tmp_w, tmp_w,
555 format_id, usage, pool, i /* Level */, j, &surface);
558 FIXME("(%p) Failed to create surface, hr %#x.\n", texture, hr);
559 cubetexture_cleanup(texture);
563 surface_set_container((IWineD3DSurfaceImpl *)surface, WINED3D_CONTAINER_TEXTURE, (IWineD3DBase *)texture);
564 surface_set_texture_target((IWineD3DSurfaceImpl *)surface, cube_targets[j]);
565 texture->baseTexture.sub_resources[idx] = (IWineD3DResourceImpl *)surface;
566 TRACE("Created surface level %u @ %p.\n", i, surface);
568 tmp_w = max(1, tmp_w >> 1);
570 texture->baseTexture.internal_preload = cubetexture_internal_preload;