85c594c1140f082dd862abde9dc7825137a3d51avboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Seamless mode.
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2007-2011 Oracle Corporation
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * available from http://www.virtualbox.org. This file is free software;
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * you can redistribute it and/or modify it under the terms of the GNU
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * General Public License (GPL) as published by the Free Software
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * The contents of this file may alternatively be used under the terms
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * of the Common Development and Distribution License Version 1.0
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * VirtualBox OSE distribution, in which case the provisions of the
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * CDDL are applicable instead of those of the GPL.
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * You may elect to license modified versions of this file under the
aba0e602e244ae7c4f11b50fc6d2440f5a762038vboxsync * terms and conditions of either the GPL or the CDDL or both.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*******************************************************************************
85c594c1140f082dd862abde9dc7825137a3d51avboxsync* Header Files *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync*******************************************************************************/
a34996f4849a881e4112ba993984dcd2388b8bf2vboxsync/* Rather than try to resolve all the header file conflicts, I will just
a34996f4849a881e4112ba993984dcd2388b8bf2vboxsync prototype what we need here. */
a34996f4849a881e4112ba993984dcd2388b8bf2vboxsyncextern "C" void* xf86memcpy(void*,const void*,xf86size_t);
a34996f4849a881e4112ba993984dcd2388b8bf2vboxsync#endif /* VBOX_VBGLR3_XFREE86 */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Tell the host that we support (or no longer support) seamless mode.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @returns IPRT status value
d00232b1c9c58409fd4b276f12e0d340e7bcc3c5vboxsync * @param fState whether or not we support seamless mode
55d9f6ae0938acb37e715dd8e24c5e6ccdbd3453vboxsync return VbglR3SetGuestCaps(VMMDEV_GUEST_SUPPORTS_SEAMLESS, 0);
55d9f6ae0938acb37e715dd8e24c5e6ccdbd3453vboxsync return VbglR3SetGuestCaps(0, VMMDEV_GUEST_SUPPORTS_SEAMLESS);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Wait for a seamless mode change event.
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * @returns IPRT status value.
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * @param[out] pMode On success, the seamless mode to switch into (i.e.
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * disabled, visible region or host window).
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync waitEvent.u32EventMaskIn = VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST;
0c1bdc5adae416967cb64e09f8ec81a5b77fe31dvboxsync rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
85c594c1140f082dd862abde9dc7825137a3d51avboxsync /* did we get the right event? */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (waitEvent.u32EventFlagsOut & VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync /* get the seamless change request */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync vmmdevInitRequest(&seamlessChangeRequest.header, VMMDevReq_GetSeamlessChangeRequest);
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync seamlessChangeRequest.mode = (VMMDevSeamlessMode)-1;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync seamlessChangeRequest.eventAck = VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST;
0c1bdc5adae416967cb64e09f8ec81a5b77fe31dvboxsync rc = vbglR3GRPerform(&seamlessChangeRequest.header);
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsync * Request the last seamless mode switch from the host again.
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * @returns IPRT status value.
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * @param[out] pMode On success, the seamless mode that was switched
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync * into (i.e. disabled, visible region or host window).
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsyncVBGLR3DECL(int) VbglR3SeamlessGetLastEvent(VMMDevSeamlessMode *pMode)
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsync /* get the seamless change request */
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsync vmmdevInitRequest(&seamlessChangeRequest.header, VMMDevReq_GetSeamlessChangeRequest);
3f7ab1ac4274d290e3b666235f774cf2dec341c3vboxsync seamlessChangeRequest.mode = (VMMDevSeamlessMode)-1;
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsync seamlessChangeRequest.eventAck = VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST;
04a4a9bac4d801c6076bc7901b7b7a87dec92190vboxsync rc = vbglR3GRPerform(&seamlessChangeRequest.header);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Inform the host about the visible region
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @returns IPRT status code
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param cRects number of rectangles in the list of visible rectangles
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param pRects list of visible rectangles on the guest display
0c1bdc5adae416967cb64e09f8ec81a5b77fe31dvboxsync * @todo A scatter-gather version of vbglR3GRPerform would be nice, so that we don't have
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * to copy our rectangle and header data into a single structure and perform an
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * additional allocation.
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync * @todo Would that really gain us much, given that the rectangles may not
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync * be grouped at all, or in the format we need? Keeping the memory
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync * for our "single structure" around (re-alloc-ing it if necessary)
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync * sounds like a simpler optimisation if we need it.
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects)
b7586b9fa1110d4f7b9bbe53e691ca71b376cb34vboxsync AssertReturn(pRects || cRects == 0, VERR_INVALID_PARAMETER);
b7586b9fa1110d4f7b9bbe53e691ca71b376cb34vboxsync AssertMsgReturn(cRects <= _1M, ("%u\n", cRects), VERR_OUT_OF_RANGE);
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync memcpy(&pReq->Rect, pRects, cRects * sizeof(RTRECT));
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync /* This will fail harmlessly for cRect == 0 and older host code */
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync LogFunc(("Visible region request returned %Rrc, internal %Rrc.\n",
814d0f5f7ee4ed571f8e823f0bdead2c2d228d44vboxsync LogFunc(("Sending %u rectangles to the host: %Rrc\n", cRects, rc));