org.virtualbox_6_1
Class IFramebuffer

java.lang.Object
  extended by org.virtualbox_6_1.IUnknown
      extended by org.virtualbox_6_1.IFramebuffer
Direct Known Subclasses:
IFramebufferOverlay

public class IFramebuffer
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_6_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IFramebuffer(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Long getBitsPerPixel()
          Color depth, in bits per pixel.
 java.lang.Long getBytesPerLine()
          Scan line size, in bytes.
 java.util.List<FramebufferCapabilities> getCapabilities()
          Capabilities of the framebuffer instance.
 java.lang.Long getHeight()
          Frame buffer height, in pixels.
 java.lang.Long getHeightReduction()
          Hint from the frame buffer about how much of the standard screen height it wants to use for itself.
 IFramebufferOverlay getOverlay()
          An alpha-blended overlay which is superposed over the frame buffer.
 BitmapFormat getPixelFormat()
          Frame buffer pixel format.
 java.lang.Long getWidth()
          Frame buffer width, in pixels.
 void notify3DEvent(java.lang.Long type, byte[] data)
          Notifies framebuffer about 3D backend event.
 void notifyChange(java.lang.Long screenId, java.lang.Long xOrigin, java.lang.Long yOrigin, java.lang.Long width, java.lang.Long height)
          Requests a size change.
 void notifyUpdate(java.lang.Long x, java.lang.Long y, java.lang.Long width, java.lang.Long height)
          Informs about an update.
 void notifyUpdateImage(java.lang.Long x, java.lang.Long y, java.lang.Long width, java.lang.Long height, byte[] image)
          Informs about an update and provides 32bpp bitmap.
static IFramebuffer queryInterface(IUnknown obj)
           
 java.lang.Boolean videoModeSupported(java.lang.Long width, java.lang.Long height, java.lang.Long bpp)
          Returns whether the frame buffer implementation is willing to support a given video mode.
 
Methods inherited from class org.virtualbox_6_1.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

IFramebuffer

public IFramebuffer(java.lang.String wrapped,
                    org.virtualbox_6_1.ObjectRefManager objMgr,
                    org.virtualbox_6_1.jaxws.VboxPortType port)
Method Detail

getWidth

public java.lang.Long getWidth()
Frame buffer width, in pixels.

Returns:
Long

getHeight

public java.lang.Long getHeight()
Frame buffer height, in pixels.

Returns:
Long

getBitsPerPixel

public java.lang.Long getBitsPerPixel()
Color depth, in bits per pixel.

Returns:
Long

getBytesPerLine

public java.lang.Long getBytesPerLine()
Scan line size, in bytes.

Returns:
Long

getPixelFormat

public BitmapFormat getPixelFormat()
Frame buffer pixel format. It's one of the values defined byBitmapFormat. NOTE: This attribute must never (and will never) returnBitmapFormat.Opaque-- the format of the frame buffer must be always known.

Returns:
org.virtualbox_6_1.BitmapFormat

getHeightReduction

public java.lang.Long getHeightReduction()
Hint from the frame buffer about how much of the standard screen height it wants to use for itself. This information is exposed to the guest through the VESA BIOS and VMMDev interface so that it can use it for determining its video mode table. It is not guaranteed that the guest respects the value.

Returns:
Long

getOverlay

public IFramebufferOverlay getOverlay()
An alpha-blended overlay which is superposed over the frame buffer. The initial purpose is to allow the display of icons providing information about the VM state, including disk activity, in front ends which do not have other means of doing that. The overlay is designed to controlled exclusively by IDisplay. It has no locking of its own, and any changes made to it are not guaranteed to be visible until the affected portion of IFramebuffer is updated. The overlay can be created lazily the first time it is requested. This attribute can also return null to signal that the overlay is not implemented.

Returns:
org.virtualbox_6_1.IFramebufferOverlay

getCapabilities

public java.util.List<FramebufferCapabilities> getCapabilities()
Capabilities of the framebuffer instance. For the meaning of individual capability flags seeFramebufferCapabilities.

Returns:
List<org.virtualbox_6_1.FramebufferCapabilities>

queryInterface

public static IFramebuffer queryInterface(IUnknown obj)

notifyUpdate

public void notifyUpdate(java.lang.Long x,
                         java.lang.Long y,
                         java.lang.Long width,
                         java.lang.Long height)
Informs about an update. Gets called by the display object where this buffer is registered.

Parameters:
x - X position of update.
y - Y position of update.
width - Width of update.
height - Height of update.

notifyUpdateImage

public void notifyUpdateImage(java.lang.Long x,
                              java.lang.Long y,
                              java.lang.Long width,
                              java.lang.Long height,
                              byte[] image)
Informs about an update and provides 32bpp bitmap.

Parameters:
x - X position of update.
y - Y position of update.
width - Width of update.
height - Height of update.
image - Array with 32BPP image data.

notifyChange

public void notifyChange(java.lang.Long screenId,
                         java.lang.Long xOrigin,
                         java.lang.Long yOrigin,
                         java.lang.Long width,
                         java.lang.Long height)
Requests a size change.

Parameters:
screenId - Logical guest screen number.
xOrigin - Location of the screen in the guest.
yOrigin - Location of the screen in the guest.
width - Width of the guest display, in pixels.
height - Height of the guest display, in pixels.

videoModeSupported

public java.lang.Boolean videoModeSupported(java.lang.Long width,
                                            java.lang.Long height,
                                            java.lang.Long bpp)
Returns whether the frame buffer implementation is willing to support a given video mode. In case it is not able to render the video mode (or for some reason not willing), it should return false. Usually this method is called when the guest asks the VMM device whether a given video mode is supported so the information returned is directly exposed to the guest. It is important that this method returns very quickly.


notify3DEvent

public void notify3DEvent(java.lang.Long type,
                          byte[] data)
Notifies framebuffer about 3D backend event.

Parameters:
type - event type. Currently only VBOX3D_NOTIFY_EVENT_TYPE_VISIBLE_3DDATA is supported.
data - event-specific data, depends on the supplied event type