|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_5_0.IUnknown
org.virtualbox_5_0.IDisplay
public class IDisplay
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, objMgr, port |
Constructor Summary | |
---|---|
IDisplay(java.lang.String wrapped,
org.virtualbox_5_0.ObjectRefManager objMgr,
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 |
---|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IDisplay(java.lang.String wrapped, org.virtualbox_5_0.ObjectRefManager objMgr, org.virtualbox_5_0.jaxws.VboxPortType port)
Method Detail |
---|
public static IDisplay queryInterface(IUnknown obj)
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)
public java.lang.String attachFramebuffer(java.lang.Long screenId, IFramebuffer framebuffer)
public void detachFramebuffer(java.lang.Long screenId, java.lang.String id)
public IFramebuffer queryFramebuffer(java.lang.Long screenId)
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)
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.width
- The width of the guest screen.height
- The height of the guest screen.bitsPerPixel
- The number of bits per pixel of the guest screen.
Expected result codes:
E_INVALIDARG | The display is not associated with any monitor. |
public void setSeamlessMode(java.lang.Boolean enabled)
IGuest.getFacilityStatus(org.virtualbox_5_0.AdditionsFacilityType,Holder)
with facility Seamless
does not return Active.
public byte[] takeScreenShotToArray(java.lang.Long screenId, java.lang.Long width, java.lang.Long height, BitmapFormat bitmapFormat)
screenId
- The guest monitor to take screenshot from.width
- Desired image width.height
- Desired image height.bitmapFormat
- The requested format.
public void invalidateAndUpdate()
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR | Could not invalidate and update screen. |
public void invalidateAndUpdateScreen(java.lang.Long screenId)
screenId
- The guest screen to redraw.public void viewportChanged(java.lang.Long screenId, java.lang.Long x, java.lang.Long y, java.lang.Long width, java.lang.Long height)
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_INVALIDARG | The specified viewport data is invalid. |
public void notifyScaleFactorChange(java.lang.Long screenId, java.lang.Long u32ScaleFactorWMultiplied, java.lang.Long u32ScaleFactorHMultiplied)
public void notifyHiDPIOutputPolicyChange(java.lang.Boolean fUnscaledHiDPI)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |