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 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, REFGUID refguid, CONST void* pData, DWORD SizeOfData, DWORD Flags) {
184 return resource_set_private_data((IWineD3DResource *)iface, refguid, pData, SizeOfData, Flags);
187 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetPrivateData(IWineD3DCubeTexture *iface, REFGUID refguid, void* pData, DWORD* pSizeOfData) {
188 return resource_get_private_data((IWineD3DResource *)iface, refguid, pData, pSizeOfData);
191 static HRESULT WINAPI IWineD3DCubeTextureImpl_FreePrivateData(IWineD3DCubeTexture *iface, REFGUID refguid) {
192 return resource_free_private_data((IWineD3DResource *)iface, refguid);
195 static DWORD WINAPI IWineD3DCubeTextureImpl_SetPriority(IWineD3DCubeTexture *iface, DWORD PriorityNew) {
196 return resource_set_priority((IWineD3DResource *)iface, PriorityNew);
199 static DWORD WINAPI IWineD3DCubeTextureImpl_GetPriority(IWineD3DCubeTexture *iface) {
200 return resource_get_priority((IWineD3DResource *)iface);
203 /* Do not call while under the GL lock. */
204 static void WINAPI IWineD3DCubeTextureImpl_PreLoad(IWineD3DCubeTexture *iface) {
205 cubetexture_internal_preload((IWineD3DBaseTexture *) iface, SRGB_ANY);
208 /* Do not call while under the GL lock. */
209 static void WINAPI IWineD3DCubeTextureImpl_UnLoad(IWineD3DCubeTexture *iface)
211 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
212 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
215 TRACE("iface %p.\n", iface);
217 /* Unload all the surfaces and reset the texture name. If UnLoad was called on the
218 * surface before, this one will be a NOP and vice versa. Unloading an unloaded
219 * surface is fine. */
221 for (i = 0; i < sub_count; ++i)
223 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
225 IWineD3DSurface_UnLoad((IWineD3DSurface *)surface);
226 surface_set_texture_name(surface, 0, TRUE);
227 surface_set_texture_name(surface, 0, FALSE);
230 basetexture_unload((IWineD3DBaseTexture *)iface);
233 static WINED3DRESOURCETYPE WINAPI IWineD3DCubeTextureImpl_GetType(IWineD3DCubeTexture *iface) {
234 return resource_get_type((IWineD3DResource *)iface);
237 static void * WINAPI IWineD3DCubeTextureImpl_GetParent(IWineD3DCubeTexture *iface)
239 TRACE("iface %p.\n", iface);
241 return ((IWineD3DCubeTextureImpl *)iface)->resource.parent;
244 /* ******************************************************
245 IWineD3DCubeTexture IWineD3DBaseTexture parts follow
246 ****************************************************** */
247 static DWORD WINAPI IWineD3DCubeTextureImpl_SetLOD(IWineD3DCubeTexture *iface, DWORD LODNew) {
248 return basetexture_set_lod((IWineD3DBaseTexture *)iface, LODNew);
251 static DWORD WINAPI IWineD3DCubeTextureImpl_GetLOD(IWineD3DCubeTexture *iface) {
252 return basetexture_get_lod((IWineD3DBaseTexture *)iface);
255 static DWORD WINAPI IWineD3DCubeTextureImpl_GetLevelCount(IWineD3DCubeTexture *iface) {
256 return basetexture_get_level_count((IWineD3DBaseTexture *)iface);
259 static HRESULT WINAPI IWineD3DCubeTextureImpl_SetAutoGenFilterType(IWineD3DCubeTexture *iface, WINED3DTEXTUREFILTERTYPE FilterType) {
260 return basetexture_set_autogen_filter_type((IWineD3DBaseTexture *)iface, FilterType);
263 static WINED3DTEXTUREFILTERTYPE WINAPI IWineD3DCubeTextureImpl_GetAutoGenFilterType(IWineD3DCubeTexture *iface) {
264 return basetexture_get_autogen_filter_type((IWineD3DBaseTexture *)iface);
267 static void WINAPI IWineD3DCubeTextureImpl_GenerateMipSubLevels(IWineD3DCubeTexture *iface) {
268 basetexture_generate_mipmaps((IWineD3DBaseTexture *)iface);
271 /* Internal function, No d3d mapping */
272 static BOOL WINAPI IWineD3DCubeTextureImpl_SetDirty(IWineD3DCubeTexture *iface, BOOL dirty) {
273 return basetexture_set_dirty((IWineD3DBaseTexture *)iface, dirty);
276 /* Internal function, No d3d mapping */
277 static BOOL WINAPI IWineD3DCubeTextureImpl_GetDirty(IWineD3DCubeTexture *iface) {
278 return basetexture_get_dirty((IWineD3DBaseTexture *)iface);
281 /* Context activation is done by the caller. */
282 static HRESULT WINAPI IWineD3DCubeTextureImpl_BindTexture(IWineD3DCubeTexture *iface, BOOL srgb) {
283 IWineD3DCubeTextureImpl *This = (IWineD3DCubeTextureImpl *)iface;
284 BOOL set_gl_texture_desc;
287 TRACE("(%p) : relay to BaseTexture\n", This);
289 hr = basetexture_bind((IWineD3DBaseTexture *)iface, srgb, &set_gl_texture_desc);
290 if (set_gl_texture_desc && SUCCEEDED(hr))
292 UINT sub_count = This->baseTexture.level_count * This->baseTexture.layer_count;
295 for (i = 0; i < sub_count; ++i)
297 IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)This->baseTexture.sub_resources[i];
299 if (This->baseTexture.is_srgb)
300 surface_set_texture_name(surface, This->baseTexture.texture_srgb.name, TRUE);
302 surface_set_texture_name(surface, This->baseTexture.texture_rgb.name, FALSE);
309 static BOOL WINAPI IWineD3DCubeTextureImpl_IsCondNP2(IWineD3DCubeTexture *iface)
311 TRACE("iface %p.\n", iface);
316 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetLevelDesc(IWineD3DCubeTexture *iface,
317 UINT sub_resource_idx, WINED3DSURFACE_DESC *desc)
319 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
320 IWineD3DSurface *surface;
322 TRACE("iface %p, sub_resource_idx %u, desc %p.\n", iface, sub_resource_idx, desc);
324 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
326 WARN("Failed to get sub-resource.\n");
327 return WINED3DERR_INVALIDCALL;
330 IWineD3DSurface_GetDesc(surface, desc);
335 static HRESULT WINAPI IWineD3DCubeTextureImpl_GetCubeMapSurface(IWineD3DCubeTexture *iface,
336 UINT sub_resource_idx, IWineD3DSurface **surface)
338 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
341 TRACE("iface %p, sub_resource_idx %u, surface %p.\n",
342 iface, sub_resource_idx, surface);
344 if (!(s = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
346 WARN("Failed to get sub-resource.\n");
347 return WINED3DERR_INVALIDCALL;
350 IWineD3DSurface_AddRef(s);
353 TRACE("Returning surface %p.\n", *surface);
358 static HRESULT WINAPI IWineD3DCubeTextureImpl_Map(IWineD3DCubeTexture *iface,
359 UINT sub_resource_idx, WINED3DLOCKED_RECT *locked_rect, const RECT *rect, DWORD flags)
361 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
362 IWineD3DSurface *surface;
364 TRACE("iface %p, sub_resource_idx %u, locked_rect %p, rect %s, flags %#x.\n",
365 iface, sub_resource_idx, locked_rect, wine_dbgstr_rect(rect), flags);
367 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
369 WARN("Failed to get sub-resource.\n");
370 return WINED3DERR_INVALIDCALL;
373 return IWineD3DSurface_Map(surface, locked_rect, rect, flags);
376 static HRESULT WINAPI IWineD3DCubeTextureImpl_Unmap(IWineD3DCubeTexture *iface,
377 UINT sub_resource_idx)
379 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
380 IWineD3DSurface *surface;
382 TRACE("iface %p, sub_resource_idx %u.\n",
383 iface, sub_resource_idx);
385 if (!(surface = (IWineD3DSurface *)basetexture_get_sub_resource(texture, sub_resource_idx)))
387 WARN("Failed to get sub-resource.\n");
388 return WINED3DERR_INVALIDCALL;
391 return IWineD3DSurface_Unmap(surface);
394 static HRESULT WINAPI IWineD3DCubeTextureImpl_AddDirtyRect(IWineD3DCubeTexture *iface,
395 WINED3DCUBEMAP_FACES face, const RECT *dirty_rect)
397 IWineD3DBaseTextureImpl *texture = (IWineD3DBaseTextureImpl *)iface;
398 UINT sub_resource_idx = face * texture->baseTexture.level_count;
399 IWineD3DSurfaceImpl *surface;
401 TRACE("iface %p, face %u, dirty_rect %s.\n",
402 iface, face, wine_dbgstr_rect(dirty_rect));
404 if (!(surface = (IWineD3DSurfaceImpl *)basetexture_get_sub_resource(texture, sub_resource_idx)))
406 WARN("Failed to get sub-resource.\n");
407 return WINED3DERR_INVALIDCALL;
410 texture->baseTexture.texture_rgb.dirty = TRUE;
411 texture->baseTexture.texture_srgb.dirty = TRUE;
412 surface_add_dirty_rect(surface, dirty_rect);
417 static const IWineD3DCubeTextureVtbl IWineD3DCubeTexture_Vtbl =
420 IWineD3DCubeTextureImpl_QueryInterface,
421 IWineD3DCubeTextureImpl_AddRef,
422 IWineD3DCubeTextureImpl_Release,
423 /* IWineD3DResource */
424 IWineD3DCubeTextureImpl_GetParent,
425 IWineD3DCubeTextureImpl_SetPrivateData,
426 IWineD3DCubeTextureImpl_GetPrivateData,
427 IWineD3DCubeTextureImpl_FreePrivateData,
428 IWineD3DCubeTextureImpl_SetPriority,
429 IWineD3DCubeTextureImpl_GetPriority,
430 IWineD3DCubeTextureImpl_PreLoad,
431 IWineD3DCubeTextureImpl_UnLoad,
432 IWineD3DCubeTextureImpl_GetType,
433 /* IWineD3DBaseTexture */
434 IWineD3DCubeTextureImpl_SetLOD,
435 IWineD3DCubeTextureImpl_GetLOD,
436 IWineD3DCubeTextureImpl_GetLevelCount,
437 IWineD3DCubeTextureImpl_SetAutoGenFilterType,
438 IWineD3DCubeTextureImpl_GetAutoGenFilterType,
439 IWineD3DCubeTextureImpl_GenerateMipSubLevels,
440 IWineD3DCubeTextureImpl_SetDirty,
441 IWineD3DCubeTextureImpl_GetDirty,
442 IWineD3DCubeTextureImpl_BindTexture,
443 IWineD3DCubeTextureImpl_IsCondNP2,
444 /* IWineD3DCubeTexture */
445 IWineD3DCubeTextureImpl_GetLevelDesc,
446 IWineD3DCubeTextureImpl_GetCubeMapSurface,
447 IWineD3DCubeTextureImpl_Map,
448 IWineD3DCubeTextureImpl_Unmap,
449 IWineD3DCubeTextureImpl_AddDirtyRect
452 HRESULT cubetexture_init(IWineD3DCubeTextureImpl *texture, UINT edge_length, UINT levels,
453 IWineD3DDeviceImpl *device, DWORD usage, enum wined3d_format_id format_id, WINED3DPOOL pool,
454 void *parent, const struct wined3d_parent_ops *parent_ops)
456 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
457 const struct wined3d_format *format = wined3d_get_format(gl_info, format_id);
458 UINT pow2_edge_length;
463 /* TODO: It should only be possible to create textures for formats
464 * that are reported as supported. */
465 if (WINED3DFMT_UNKNOWN >= format_id)
467 WARN("(%p) : Texture cannot be created with a format of WINED3DFMT_UNKNOWN.\n", texture);
468 return WINED3DERR_INVALIDCALL;
471 if (!gl_info->supported[ARB_TEXTURE_CUBE_MAP] && pool != WINED3DPOOL_SCRATCH)
473 WARN("(%p) : Tried to create not supported cube texture.\n", texture);
474 return WINED3DERR_INVALIDCALL;
477 /* Calculate levels for mip mapping */
478 if (usage & WINED3DUSAGE_AUTOGENMIPMAP)
480 if (!gl_info->supported[SGIS_GENERATE_MIPMAP])
482 WARN("No mipmap generation support, returning D3DERR_INVALIDCALL.\n");
483 return WINED3DERR_INVALIDCALL;
488 WARN("D3DUSAGE_AUTOGENMIPMAP is set, and level count > 1, returning D3DERR_INVALIDCALL.\n");
489 return WINED3DERR_INVALIDCALL;
496 levels = wined3d_log2i(edge_length) + 1;
497 TRACE("Calculated levels = %u.\n", levels);
500 texture->lpVtbl = &IWineD3DCubeTexture_Vtbl;
502 hr = basetexture_init((IWineD3DBaseTextureImpl *)texture, 6, levels,
503 WINED3DRTYPE_CUBETEXTURE, device, usage, format, pool, parent, parent_ops);
506 WARN("Failed to initialize basetexture, returning %#x\n", hr);
510 /* Find the nearest pow2 match. */
511 pow2_edge_length = 1;
512 while (pow2_edge_length < edge_length) pow2_edge_length <<= 1;
514 if (gl_info->supported[ARB_TEXTURE_NON_POWER_OF_TWO] || (edge_length == pow2_edge_length))
516 /* Precalculated scaling for 'faked' non power of two texture coords. */
517 texture->baseTexture.pow2Matrix[0] = 1.0f;
518 texture->baseTexture.pow2Matrix[5] = 1.0f;
519 texture->baseTexture.pow2Matrix[10] = 1.0f;
520 texture->baseTexture.pow2Matrix[15] = 1.0f;
524 /* Precalculated scaling for 'faked' non power of two texture coords. */
525 texture->baseTexture.pow2Matrix[0] = ((float)edge_length) / ((float)pow2_edge_length);
526 texture->baseTexture.pow2Matrix[5] = ((float)edge_length) / ((float)pow2_edge_length);
527 texture->baseTexture.pow2Matrix[10] = ((float)edge_length) / ((float)pow2_edge_length);
528 texture->baseTexture.pow2Matrix[15] = 1.0f;
529 texture->baseTexture.pow2Matrix_identity = FALSE;
531 texture->baseTexture.target = GL_TEXTURE_CUBE_MAP_ARB;
533 /* Generate all the surfaces. */
535 for (i = 0; i < texture->baseTexture.level_count; ++i)
537 /* Create the 6 faces. */
538 for (j = 0; j < 6; ++j)
540 static const GLenum cube_targets[6] =
542 GL_TEXTURE_CUBE_MAP_POSITIVE_X_ARB,
543 GL_TEXTURE_CUBE_MAP_NEGATIVE_X_ARB,
544 GL_TEXTURE_CUBE_MAP_POSITIVE_Y_ARB,
545 GL_TEXTURE_CUBE_MAP_NEGATIVE_Y_ARB,
546 GL_TEXTURE_CUBE_MAP_POSITIVE_Z_ARB,
547 GL_TEXTURE_CUBE_MAP_NEGATIVE_Z_ARB,
549 UINT idx = j * texture->baseTexture.level_count + i;
550 IWineD3DSurface *surface;
552 hr = IWineD3DDeviceParent_CreateSurface(device->device_parent, parent, tmp_w, tmp_w,
553 format_id, usage, pool, i /* Level */, j, &surface);
556 FIXME("(%p) Failed to create surface, hr %#x.\n", texture, hr);
557 cubetexture_cleanup(texture);
561 surface_set_container((IWineD3DSurfaceImpl *)surface, WINED3D_CONTAINER_TEXTURE, (IWineD3DBase *)texture);
562 surface_set_texture_target((IWineD3DSurfaceImpl *)surface, cube_targets[j]);
563 texture->baseTexture.sub_resources[idx] = (IWineD3DResourceImpl *)surface;
564 TRACE("Created surface level %u @ %p.\n", i, surface);
566 tmp_w = max(1, tmp_w >> 1);
568 texture->baseTexture.internal_preload = cubetexture_internal_preload;