From: Matthew Wong itsmattkc@gmail.com
Implement functions used by some games for determining which 3D object in a scene was either moused over or clicked on by the mouse.
Picking has been implemented by adding a "pick mode" in d3d_execute_buffer_execute() which skips any drawing functions leaving just the vertex processing. Adds click tests for each triangle when in pick mode for creating an array of D3DPICKRECORDs.
Pick() implementation may have slight inaccuracies to the original function; occasionally pixels right on triangle edges result in successful picks when they don't with the original function (and vice versa). In practice, I believe this inaccuracy is so negligible that it won't produce any undesirable results for the user.
Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=10729 Signed-off-by: Matthew Wong <itsmattkc(a)gmail.com> --- dlls/ddraw/ddraw_private.h | 6 +- dlls/ddraw/device.c | 64 ++++++++++-- dlls/ddraw/executebuffer.c | 207 +++++++++++++++++++++++++++++++++++-- dlls/ddraw/tests/ddraw1.c | 16 +-- 4 files changed, 268 insertions(+), 25 deletions(-)
diff --git a/dlls/ddraw/ddraw_private.h b/dlls/ddraw/ddraw_private.h index 01a9579651c..912813ccc48 100644 --- a/dlls/ddraw/ddraw_private.h +++ b/dlls/ddraw/ddraw_private.h @@ -336,6 +336,10 @@ struct d3d_device struct d3d_viewport *current_viewport; D3DVIEWPORT7 active_viewport;
+ /* Pick data */ + D3DPICKRECORD *pick_records; + DWORD pick_record_count; + /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */ BOOL legacyTextureBlending; D3DTEXTUREBLEND texture_map_blend; @@ -569,7 +573,7 @@ struct d3d_execute_buffer *unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExec
/* The execute function */ HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *execute_buffer, - struct d3d_device *device); + struct d3d_device *device, D3DRECT *pick_rect);
/***************************************************************************** * IDirect3DVertexBuffer diff --git a/dlls/ddraw/device.c b/dlls/ddraw/device.c index 80556e96787..ac4388ab639 100644 --- a/dlls/ddraw/device.c +++ b/dlls/ddraw/device.c @@ -349,6 +349,10 @@ static ULONG WINAPI d3d_device_inner_Release(IUnknown *iface) IDirect3DDevice3_DeleteViewport(&This->IDirect3DDevice3_iface, &vp->IDirect3DViewport3_iface); }
+ /* Free pick records array if any are allocated */ + if (This->pick_record_count > 0) + free(This->pick_records); + TRACE("Releasing render target %p.\n", This->rt_iface); rt_iface = This->rt_iface; This->rt_iface = NULL; @@ -758,7 +762,7 @@ static HRESULT WINAPI d3d_device1_Execute(IDirect3DDevice *iface,
/* Execute... */ wined3d_mutex_lock(); - hr = d3d_execute_buffer_execute(buffer, device); + hr = d3d_execute_buffer_execute(buffer, device, NULL); wined3d_mutex_unlock();
return hr; @@ -1025,16 +1029,37 @@ static HRESULT WINAPI d3d_device1_NextViewport(IDirect3DDevice *iface, * x2 and y2 are ignored. * * Returns: - * D3D_OK because it's a stub + * D3D_OK on success + * DDERR_INVALIDPARAMS if any of the parameters == NULL * *****************************************************************************/ static HRESULT WINAPI d3d_device1_Pick(IDirect3DDevice *iface, IDirect3DExecuteBuffer *buffer, IDirect3DViewport *viewport, DWORD flags, D3DRECT *rect) { - FIXME("iface %p, buffer %p, viewport %p, flags %#lx, rect %s stub!\n", + struct d3d_device *device = impl_from_IDirect3DDevice(iface); + struct d3d_execute_buffer *buffer_impl = unsafe_impl_from_IDirect3DExecuteBuffer(buffer); + struct d3d_viewport *viewport_impl = unsafe_impl_from_IDirect3DViewport(viewport); + HRESULT hr; + + TRACE("iface %p, buffer %p, viewport %p, flags %#lx, rect %s.\n", iface, buffer, viewport, flags, wine_dbgstr_rect((RECT *)rect));
- return D3D_OK; + /* Sanity checks */ + if (!iface || !buffer || !viewport) + { + return DDERR_INVALIDPARAMS; + } + + if (FAILED(hr = IDirect3DDevice3_SetCurrentViewport + (&device->IDirect3DDevice3_iface, &viewport_impl->IDirect3DViewport3_iface))) + return hr; + + /* Execute the pick */ + wined3d_mutex_lock(); + hr = d3d_execute_buffer_execute(buffer_impl, device, rect); + wined3d_mutex_unlock(); + + return hr; }
/***************************************************************************** @@ -1050,13 +1075,37 @@ static HRESULT WINAPI d3d_device1_Pick(IDirect3DDevice *iface, IDirect3DExecuteB * D3DPickRec: Address to store the resulting D3DPICKRECORD array. * * Returns: - * D3D_OK, because it's a stub + * D3D_OK always * *****************************************************************************/ static HRESULT WINAPI d3d_device1_GetPickRecords(IDirect3DDevice *iface, DWORD *count, D3DPICKRECORD *records) { - FIXME("iface %p, count %p, records %p stub!\n", iface, count, records); + struct d3d_device *device; + + TRACE("iface %p, count %p, records %p.\n", iface, count, records); + + wined3d_mutex_lock(); + + device = impl_from_IDirect3DDevice(iface); + + /* Set count to the number of pick records we have */ + *count = device->pick_record_count; + + /* It is correct usage according to documentation to call this function with records == NULL + to retrieve _just_ the record count, which the caller can then use to allocate an + appropriately sized array, then call this function again to fill that array with data. */ + if (records && count) + { + /* If we have a destination array and records to copy, copy them now */ + memcpy(records, device->pick_records, sizeof(*device->pick_records) * device->pick_record_count); + + /* We're now done with the old pick records and can free them */ + free(device->pick_records); + device->pick_record_count = 0; + } + + wined3d_mutex_unlock();
return D3D_OK; } @@ -6893,6 +6942,9 @@ static HRESULT d3d_device_init(struct d3d_device *device, struct ddraw *ddraw, c
ddraw->d3ddevice = device;
+ /* Initialize pick records array */ + device->pick_record_count = 0; + wined3d_stateblock_set_render_state(ddraw->state, WINED3D_RS_ZENABLE, d3d_device_update_depth_stencil(device)); if (version == 1) /* Color keying is initially enabled for version 1 devices. */ diff --git a/dlls/ddraw/executebuffer.c b/dlls/ddraw/executebuffer.c index 13e639eda3f..bc95b3e2a82 100644 --- a/dlls/ddraw/executebuffer.c +++ b/dlls/ddraw/executebuffer.c @@ -45,15 +45,111 @@ static void _dump_D3DEXECUTEBUFFERDESC(const D3DEXECUTEBUFFERDESC *lpDesc) { TRACE("lpData : %p\n", lpDesc->lpData); }
-HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d_device *device) +#define TRIANGLE_SIZE 3 +/***************************************************************************** + * d3d_execute_buffer_pick_test + * + * Determines whether a "point" is inside a "triangle". Mainly used when + * executing a "pick" from an execute buffer to determine whether a pixel + * coordinate (often a mouse coordinate) is inside a triangle (and + * therefore clicking or hovering over a 3D object in the scene). This + * function uses triangle rasterization algorithms to determine if the + * pixel falls inside (using the top-left rule, in accordance with + * documentation). + * + * Params: + * x: The X coordinate of the point to verify. + * y: The Y coordinate of the point to verify. + * verts: An array of vertices describing the screen coordinates of the + * triangle. This function expects 3 elements in this array. + * + * Returns: + * TRUE if the pixel coordinate is inside this triangle + * FALSE if not + * + *****************************************************************************/ +static BOOL d3d_execute_buffer_pick_test(LONG x, LONG y, D3DTLVERTEX* verts) +{ + UINT i; + + for (i = 0; i < TRIANGLE_SIZE; i++) + { + D3DTLVERTEX* v1 = &verts[(i) % TRIANGLE_SIZE]; + D3DTLVERTEX* v2 = &verts[(i + 1) % TRIANGLE_SIZE]; + D3DVALUE bias = 0.0f; + + /* Edge function - determines whether pixel is inside triangle */ + D3DVALUE w = (v2->sx - v1->sx) * (y - v1->sy) - (v2->sy - v1->sy) * (x - v1->sx); + + /* Force top-left rule */ + if ((v1->sy == v2->sy && v1->sx > v2->sx) || (v1->sy < v2->sy)) + bias = 1.0f; + + if (w < bias) + return FALSE; + } + + return TRUE; +} + +/***************************************************************************** + * d3d_execute_buffer_z_value_at_coords + * + * Returns the Z point of a triangle given an X, Y coordinate somewhere inside + * the triangle. Used as the `dvZ` parameter of D3DPICKRECORD. + * + * Params: + * x: The X coordinate of the point to verify. + * y: The Y coordinate of the point to verify. + * verts: An array of vertices describing the screen coordinates of the + * triangle. This function expects 3 elements in this array. + * + * Returns: + * A floating-point Z value that can be used directly as the dvZ member of a + * D3DPICKRECORD. + * + *****************************************************************************/ +static D3DVALUE d3d_execute_buffer_z_value_at_coords(LONG x, LONG y, D3DTLVERTEX* verts) +{ + UINT i; + + D3DVALUE z1 = 0; + D3DVALUE z2 = 0; + + for (i = 0; i < TRIANGLE_SIZE; i++) + { + D3DTLVERTEX* v1 = &verts[i]; + D3DTLVERTEX* v2 = &verts[(i + 1) % TRIANGLE_SIZE]; + D3DTLVERTEX* v3 = &verts[(i + 2) % TRIANGLE_SIZE]; + + z1 += v3->sz * (x - v1->sx) * (y - v2->sy) - v2->sz * (x - v1->sx) * (y - v3->sy); + z2 += (x - v1->sx) * (y - v2->sy) - (x - v1->sx) * (y - v3->sy); + } + + return z1 / z2; +} + +HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d_device *device, + D3DRECT* pick_rect) { DWORD is = buffer->data.dwInstructionOffset; char *instr = (char *)buffer->desc.lpData + is; unsigned int i, primitive_size; - struct wined3d_map_desc map_desc; + struct wined3d_map_desc map_desc, vert_map_desc; struct wined3d_box box = {0}; HRESULT hr;
+ /* Variables used for picking */ + const unsigned int vertex_size = get_flexible_vertex_size(D3DFVF_TLVERTEX); + D3DTLVERTEX verts[TRIANGLE_SIZE]; + + /* Check for any un-freed pick records */ + if (device->pick_record_count > 0) + { + free(device->pick_records); + device->pick_record_count = 0; + } + TRACE("ExecuteData :\n"); if (TRACE_ON(ddraw)) _dump_executedata(&(buffer->data)); @@ -69,6 +165,26 @@ HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d instr += sizeof(*current); primitive_size = 0;
+ /* We can skip these opcodes when Picking */ + if (pick_rect) + { + switch (current->bOpcode) + { + /* None of these opcodes seem to be necessary for picking */ + case D3DOP_POINT: + case D3DOP_LINE: + case D3DOP_STATETRANSFORM: + case D3DOP_STATELIGHT: + case D3DOP_STATERENDER: + case D3DOP_TEXTURELOAD: + case D3DOP_SPAN: + instr += count * size; + continue; + default: + break; + } + } + switch (current->bOpcode) { case D3DOP_POINT: @@ -174,6 +290,72 @@ HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d { case 3: indices[(i * primitive_size) + 2] = ci->v3; + + if (pick_rect) + { + UINT j; + + /* Get D3DTLVERTEX objects for each triangle vertex */ + for (j = 0; j < TRIANGLE_SIZE; j++) + { + /* Get index of vertex from D3DTRIANGLE struct */ + switch (j) { + case 0: box.left = vertex_size * ci->v1; break; + case 1: box.left = vertex_size * ci->v2; break; + case 2: box.left = vertex_size * ci->v3; break; + } + + box.right = box.left + vertex_size; + if (FAILED(hr = wined3d_resource_map(wined3d_buffer_get_resource(buffer->dst_vertex_buffer), + 0, &vert_map_desc, &box, WINED3D_MAP_WRITE))) + { + return hr; + } + else + { + /* Copy vert data into stack array */ + verts[j] = *((D3DTLVERTEX*)vert_map_desc.data); + + wined3d_resource_unmap(wined3d_buffer_get_resource(buffer->dst_vertex_buffer), 0); + } + } + + /* Use vertices acquired above to test for clicking */ + if (d3d_execute_buffer_pick_test(pick_rect->x1, pick_rect->y1, verts)) + { + D3DPICKRECORD* record; + + /* Create new array to fit one more record */ + DWORD new_record_count = device->pick_record_count + 1; + D3DPICKRECORD* new_record_array = malloc(sizeof(*device->pick_records) * new_record_count); + if (device->pick_record_count > 0) + { + memcpy(new_record_array, device->pick_records, sizeof(*device->pick_records) * device->pick_record_count); + free(device->pick_records); + } + + /* Fill record parameters */ + record = &new_record_array[device->pick_record_count]; + + record->bOpcode = current->bOpcode; + record->bPad = 0; + + /* Write current instruction offset into file */ + record->dwOffset = instr - (char *)buffer->desc.lpData - is; + + /* Formula for returning the Z value at this X/Y */ + record->dvZ = d3d_execute_buffer_z_value_at_coords(pick_rect->x1, pick_rect->y1, verts); + + /* Point device info to new record information */ + device->pick_records = new_record_array; + device->pick_record_count = new_record_count; + + /* We have a successful pick so we can skip the rest of the triangles */ + instr += size * (count - i - 1); + count = i; + } + } + /* Drop through. */ case 2: indices[(i * primitive_size) + 1] = ci->v2; @@ -184,14 +366,18 @@ HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d
wined3d_resource_unmap(wined3d_buffer_get_resource(buffer->index_buffer), 0);
- wined3d_stateblock_set_stream_source(device->state, 0, - buffer->dst_vertex_buffer, 0, sizeof(D3DTLVERTEX)); - wined3d_stateblock_set_vertex_declaration(device->state, - ddraw_find_decl(device->ddraw, D3DFVF_TLVERTEX)); - wined3d_stateblock_set_index_buffer(device->state, buffer->index_buffer, WINED3DFMT_R16_UINT); - wined3d_device_apply_stateblock(device->wined3d_device, device->state); - d3d_device_sync_surfaces(device); - wined3d_device_context_draw_indexed(device->immediate_context, 0, index_pos, index_count, 0, 0); + /* Skip drawing if we're picking */ + if (!pick_rect) + { + wined3d_stateblock_set_stream_source(device->state, 0, + buffer->dst_vertex_buffer, 0, sizeof(D3DTLVERTEX)); + wined3d_stateblock_set_vertex_declaration(device->state, + ddraw_find_decl(device->ddraw, D3DFVF_TLVERTEX)); + wined3d_stateblock_set_index_buffer(device->state, buffer->index_buffer, WINED3DFMT_R16_UINT); + wined3d_device_apply_stateblock(device->wined3d_device, device->state); + d3d_device_sync_surfaces(device); + wined3d_device_context_draw_indexed(device->immediate_context, 0, index_pos, index_count, 0, 0); + }
buffer->index_pos = index_pos + index_count; break; @@ -426,6 +612,7 @@ HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *buffer, struct d3d end_of_buffer: return D3D_OK; } +#undef TRIANGLE_SIZE
static inline struct d3d_execute_buffer *impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer *iface) { diff --git a/dlls/ddraw/tests/ddraw1.c b/dlls/ddraw/tests/ddraw1.c index b009cb755a3..1ce8c6bf71b 100644 --- a/dlls/ddraw/tests/ddraw1.c +++ b/dlls/ddraw/tests/ddraw1.c @@ -15528,7 +15528,7 @@ static void test_pick(void) } }
- todo_wine ok(hits + nohits > 0, "Did not get any pick hits or misses.\n"); + ok(hits + nohits > 0, "Did not get any pick hits or misses.\n"); ok(hits == nohits, "Got a non-equal amount of pick hits/misses: %i vs %i.\n", hits, nohits);
/* Pick a pixel where no quads are present */ @@ -15539,7 +15539,7 @@ static void test_pick(void) rec_count = ~0; hr = IDirect3DDevice_GetPickRecords(device, &rec_count, NULL); ok(SUCCEEDED(hr), "Failed to get pick records, hr %#lx.\n", hr); - todo_wine ok(rec_count == 0, "Got incorrect number of pick records (expected 0): %lu.\n", rec_count); + ok(rec_count == 0, "Got incorrect number of pick records (expected 0): %lu.\n", rec_count);
/* Pick a pixel where one quad is present */ pick_rect.x1 = pick_rect.x2 = 240; @@ -15549,7 +15549,7 @@ static void test_pick(void) rec_count = ~0; hr = IDirect3DDevice_GetPickRecords(device, &rec_count, NULL); ok(SUCCEEDED(hr), "Failed to get pick records, hr %#lx.\n", hr); - todo_wine ok(rec_count == 1, "Got incorrect number of pick records (expected 1): %lu.\n", rec_count); + ok(rec_count == 1, "Got incorrect number of pick records (expected 1): %lu.\n", rec_count);
if (rec_count == 1) { @@ -15573,7 +15573,7 @@ static void test_pick(void) rec_count = ~0; hr = IDirect3DDevice_GetPickRecords(device, &rec_count, NULL); ok(SUCCEEDED(hr), "Failed to get pick records, hr %#lx.\n", hr); - todo_wine ok(rec_count == 3, "Got incorrect number of pick records (expected 3): %lu.\n", rec_count); + ok(rec_count == 3, "Got incorrect number of pick records (expected 3): %lu.\n", rec_count);
if (rec_count == 3) { @@ -15585,9 +15585,9 @@ static void test_pick(void) hr = IDirect3DDevice_GetPickRecords(device, &rec_count, &record[0]); ok(SUCCEEDED(hr), "Failed to get pick records, hr %#lx.\n", hr); ok(rec_count == 3, "Got incorrect number of pick records (expected 3): %lu.\n", rec_count); - ok(memcmp(&record[0], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n"); - ok(memcmp(&record[1], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n"); - ok(memcmp(&record[2], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n"); + todo_wine ok(memcmp(&record[0], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n"); + todo_wine ok(memcmp(&record[1], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n"); + todo_wine ok(memcmp(&record[2], &empty_record, sizeof(D3DPICKRECORD)) == 0, "Got unexpected pick record.\n");
rec_count = 3; hr = IDirect3DDevice_GetPickRecords(device, &rec_count, &record[0]); @@ -15618,7 +15618,7 @@ static void test_pick(void) rec_count = ~0; hr = IDirect3DDevice_GetPickRecords(device, &rec_count, NULL); ok(SUCCEEDED(hr), "Failed to get pick records, hr %#lx.\n", hr); - todo_wine ok(rec_count == 1, "Got incorrect number of pick records (expected 1): %lu.\n", rec_count); + ok(rec_count == 1, "Got incorrect number of pick records (expected 1): %lu.\n", rec_count);
if (rec_count == 1) {