org.virtualbox_6_0
Class IFramebufferOverlay

java.lang.Object
  extended by org.virtualbox_6_0.IUnknown
      extended by org.virtualbox_6_0.IFramebuffer
          extended by org.virtualbox_6_0.IFramebufferOverlay

public class IFramebufferOverlay
extends IFramebuffer

The IFramebufferOverlay interface represents an alpha blended overlay for displaying status icons above an IFramebuffer. It is always created not visible, so that it must be explicitly shown. It only covers a portion of the IFramebuffer, determined by its width, height and co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in that order) format, and may be written to directly. Do re-read the width though, after setting it, as it may be adjusted (increased) to make it more suitable for the front end. Interface ID: {AF398A9A-6B76-4805-8FAB-00A9DCF4732B}


Field Summary
 
Fields inherited from class org.virtualbox_6_0.IUnknown
obj, objMgr, port
 
Constructor Summary
IFramebufferOverlay(java.lang.String wrapped, org.virtualbox_6_0.ObjectRefManager objMgr, org.virtualbox_6_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Long getAlpha()
          The global alpha value for the overlay.
 java.lang.Boolean getVisible()
          Whether the overlay is currently visible.
 java.lang.Long getX()
          X position of the overlay, relative to the frame buffer.
 java.lang.Long getY()
          Y position of the overlay, relative to the frame buffer.
 void move(java.lang.Long x, java.lang.Long y)
          Changes the overlay's position relative to the IFramebuffer.
static IFramebufferOverlay queryInterface(IUnknown obj)
           
 void setAlpha(java.lang.Long value)
          The global alpha value for the overlay.
 void setVisible(java.lang.Boolean value)
          Whether the overlay is currently visible.
 
Methods inherited from class org.virtualbox_6_0.IFramebuffer
getBitsPerPixel, getBytesPerLine, getCapabilities, getHeight, getHeightReduction, getOverlay, getPixelFormat, getWidth, notify3DEvent, notifyChange, notifyUpdate, notifyUpdateImage, videoModeSupported
 
Methods inherited from class org.virtualbox_6_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

IFramebufferOverlay

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

getX

public java.lang.Long getX()
X position of the overlay, relative to the frame buffer.

Returns:
Long

getY

public java.lang.Long getY()
Y position of the overlay, relative to the frame buffer.

Returns:
Long

getVisible

public java.lang.Boolean getVisible()
Whether the overlay is currently visible.

Returns:
Boolean

setVisible

public void setVisible(java.lang.Boolean value)
Whether the overlay is currently visible.

Parameters:
value - Boolean

getAlpha

public java.lang.Long getAlpha()
The global alpha value for the overlay. This may or may not be supported by a given front end.

Returns:
Long

setAlpha

public void setAlpha(java.lang.Long value)
The global alpha value for the overlay. This may or may not be supported by a given front end.

Parameters:
value - Long

queryInterface

public static IFramebufferOverlay queryInterface(IUnknown obj)

move

public void move(java.lang.Long x,
                 java.lang.Long y)
Changes the overlay's position relative to the IFramebuffer.