org.virtualbox_5_0
Class IDisplay

java.lang.Object
  extended by org.virtualbox_5_0.IUnknown
      extended by org.virtualbox_5_0.IDisplay

public class IDisplay
extends IUnknown

The IDisplay interface represents the virtual machine's display. The object implementing this interface is contained in eachIConsole.getDisplay()attribute and represents the visual output of the virtual machine. The virtual display supports pluggable output targets represented by the IFramebuffer interface. Examples of the output target are a window on the host computer or an RDP session's display on a remote computer. Interface ID: {7303A66D-433B-25A4-F9A8-FCADF87E0C2A}


Field Summary
 
Fields inherited from class org.virtualbox_5_0.IUnknown
obj, port
 
Constructor Summary
IDisplay(java.lang.String wrapped, org.virtualbox_5_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.String attachFramebuffer(java.lang.Long screenId, IFramebuffer framebuffer)
          Sets the graphics update target for a screen.
 void detachFramebuffer(java.lang.Long screenId, java.lang.String id)
          Removes the graphics updates target for a screen.
 void getScreenResolution(java.lang.Long screenId, Holder<java.lang.Long> width, Holder<java.lang.Long> height, Holder<java.lang.Long> bitsPerPixel, Holder<java.lang.Integer> xOrigin, Holder<java.lang.Integer> yOrigin, Holder<GuestMonitorStatus> guestMonitorStatus)
          Queries certain attributes such as display width, height, color depth and the X and Y origin for a given guest screen.
 void invalidateAndUpdate()
          Does a full invalidation of the VM display and instructs the VM to update it.
 void invalidateAndUpdateScreen(java.lang.Long screenId)
          Redraw the specified VM screen.
 void notifyHiDPIOutputPolicyChange(java.lang.Boolean fUnscaledHiDPI)
          Notify OpenGL HGCM host service about HiDPI monitor scaling policy change.
 void notifyScaleFactorChange(java.lang.Long screenId, java.lang.Long u32ScaleFactorWMultiplied, java.lang.Long u32ScaleFactorHMultiplied)
          Notify OpenGL HGCM host service about graphics content scaling factor change.
 IFramebuffer queryFramebuffer(java.lang.Long screenId)
          Queries the graphics updates targets for a screen.
static IDisplay queryInterface(IUnknown obj)
           
 void setSeamlessMode(java.lang.Boolean enabled)
          Enables or disables seamless guest display rendering (seamless desktop integration) mode.
 void setVideoModeHint(java.lang.Long display, java.lang.Boolean enabled, java.lang.Boolean changeOrigin, java.lang.Integer originX, java.lang.Integer originY, java.lang.Long width, java.lang.Long height, java.lang.Long bitsPerPixel)
          Asks VirtualBox to request the given video mode from the guest.
 byte[] takeScreenShotToArray(java.lang.Long screenId, java.lang.Long width, java.lang.Long height, BitmapFormat bitmapFormat)
          Takes a guest screen shot of the requested size and format and returns it as an array of bytes.
 void viewportChanged(java.lang.Long screenId, java.lang.Long x, java.lang.Long y, java.lang.Long width, java.lang.Long height)
          Signals that framebuffer window viewport has changed.
 
Methods inherited from class org.virtualbox_5_0.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDisplay

public IDisplay(java.lang.String wrapped,
                org.virtualbox_5_0.jaxws.VboxPortType port)
Method Detail

queryInterface

public static IDisplay queryInterface(IUnknown obj)

getScreenResolution

public void getScreenResolution(java.lang.Long screenId,
                                Holder<java.lang.Long> width,
                                Holder<java.lang.Long> height,
                                Holder<java.lang.Long> bitsPerPixel,
                                Holder<java.lang.Integer> xOrigin,
                                Holder<java.lang.Integer> yOrigin,
                                Holder<GuestMonitorStatus> guestMonitorStatus)
Queries certain attributes such as display width, height, color depth and the X and Y origin for a given guest screen. The parameters xOrigin and yOrigin return the X and Y coordinates of the framebuffer's origin. All return parameters are optional.


attachFramebuffer

public java.lang.String attachFramebuffer(java.lang.Long screenId,
                                          IFramebuffer framebuffer)
Sets the graphics update target for a screen.


detachFramebuffer

public void detachFramebuffer(java.lang.Long screenId,
                              java.lang.String id)
Removes the graphics updates target for a screen.


queryFramebuffer

public IFramebuffer queryFramebuffer(java.lang.Long screenId)
Queries the graphics updates targets for a screen.


setVideoModeHint

public void setVideoModeHint(java.lang.Long display,
                             java.lang.Boolean enabled,
                             java.lang.Boolean changeOrigin,
                             java.lang.Integer originX,
                             java.lang.Integer originY,
                             java.lang.Long width,
                             java.lang.Long height,
                             java.lang.Long bitsPerPixel)
Asks VirtualBox to request the given video mode from the guest. This is just a hint and it cannot be guaranteed that the requested resolution will be used. Guest Additions are required for the request to be seen by guests. The caller should issue the request and wait for a resolution change and after a timeout retry. Specifying 0 for either width, height or bitsPerPixel parameters means that the corresponding values should be taken from the current video mode (i.e. left unchanged). If the guest OS supports multi-monitor configuration then the display parameter specifies the number of the guest display to send the hint to: 0 is the primary display, 1 is the first secondary and so on. If the multi-monitor configuration is not supported, display must be 0.

Parameters:
display - The number of the guest display to send the hint to.
enabled - True, if this guest screen is enabled, False otherwise.
changeOrigin - True, if the origin of the guest screen should be changed, False otherwise.
originX - The X origin of the guest screen.
originY - The Y origin of the guest screen. Expected result codes:
E_INVALIDARGThe display is not associated with any monitor.

setSeamlessMode

public void setSeamlessMode(java.lang.Boolean enabled)
Enables or disables seamless guest display rendering (seamless desktop integration) mode. NOTE: Calling this method has no effect ifIGuest.getFacilityStatus(org.virtualbox_5_0.AdditionsFacilityType,Holder)with facility Seamless does not return Active.


takeScreenShotToArray

public byte[] takeScreenShotToArray(java.lang.Long screenId,
                                    java.lang.Long width,
                                    java.lang.Long height,
                                    BitmapFormat bitmapFormat)
Takes a guest screen shot of the requested size and format and returns it as an array of bytes.

Parameters:
screenId - The guest monitor to take screenshot from.
width - Desired image width.
height - Desired image height.
bitmapFormat - The requested format.
Returns:
Array with resulting screen data.

invalidateAndUpdate

public void invalidateAndUpdate()
Does a full invalidation of the VM display and instructs the VM to update it. Expected result codes:
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERRORCould not invalidate and update screen.


invalidateAndUpdateScreen

public void invalidateAndUpdateScreen(java.lang.Long screenId)
Redraw the specified VM screen.

Parameters:
screenId - The guest screen to redraw.

viewportChanged

public void viewportChanged(java.lang.Long screenId,
                            java.lang.Long x,
                            java.lang.Long y,
                            java.lang.Long width,
                            java.lang.Long height)
Signals that framebuffer window viewport has changed.

Parameters:
screenId - Monitor to take the screenshot from.
x - Framebuffer x offset.
y - Framebuffer y offset.
width - Viewport width.
height - Viewport height. Expected result codes:
E_INVALIDARGThe specified viewport data is invalid.

notifyScaleFactorChange

public void notifyScaleFactorChange(java.lang.Long screenId,
                                    java.lang.Long u32ScaleFactorWMultiplied,
                                    java.lang.Long u32ScaleFactorHMultiplied)
Notify OpenGL HGCM host service about graphics content scaling factor change.


notifyHiDPIOutputPolicyChange

public void notifyHiDPIOutputPolicyChange(java.lang.Boolean fUnscaledHiDPI)
Notify OpenGL HGCM host service about HiDPI monitor scaling policy change.