org.virtualbox_5_0
Class IMousePointerShapeChangedEvent

java.lang.Object
  extended by org.virtualbox_5_0.IUnknown
      extended by org.virtualbox_5_0.IEvent
          extended by org.virtualbox_5_0.IMousePointerShapeChangedEvent

public class IMousePointerShapeChangedEvent
extends IEvent

Notification when the guest mouse pointer shape has changed. The new shape data is given. Interface ID: {A6DCF6E8-416B-4181-8C4A-45EC95177AEF}


Field Summary
 
Fields inherited from class org.virtualbox_5_0.IUnknown
obj, objMgr, port
 
Constructor Summary
IMousePointerShapeChangedEvent(java.lang.String wrapped, org.virtualbox_5_0.ObjectRefManager objMgr, org.virtualbox_5_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getAlpha()
          Flag whether the pointer has an alpha channel.
 java.lang.Long getHeight()
          Height of the pointer shape in pixels.
 byte[] getShape()
          Shape buffer arrays.
 java.lang.Boolean getVisible()
          Flag whether the pointer is visible.
 java.lang.Long getWidth()
          Width of the pointer shape in pixels.
 java.lang.Long getXhot()
          The pointer hot spot X coordinate.
 java.lang.Long getYhot()
          The pointer hot spot Y coordinate.
static IMousePointerShapeChangedEvent queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_5_0.IEvent
getSource, getType, getWaitable, setProcessed, waitProcessed
 
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

IMousePointerShapeChangedEvent

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

getVisible

public java.lang.Boolean getVisible()
Flag whether the pointer is visible.

Returns:
Boolean

getAlpha

public java.lang.Boolean getAlpha()
Flag whether the pointer has an alpha channel.

Returns:
Boolean

getXhot

public java.lang.Long getXhot()
The pointer hot spot X coordinate.

Returns:
Long

getYhot

public java.lang.Long getYhot()
The pointer hot spot Y coordinate.

Returns:
Long

getWidth

public java.lang.Long getWidth()
Width of the pointer shape in pixels.

Returns:
Long

getHeight

public java.lang.Long getHeight()
Height of the pointer shape in pixels.

Returns:
Long

getShape

public byte[] getShape()
Shape buffer arrays. The shape buffer contains a 1-bpp (bits per pixel) AND mask followed by a 32-bpp XOR (color) mask. For pointers without alpha channel the XOR mask pixels are 32-bit values: (lsb)BGR0(msb). For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32-bit values. An AND mask is used for pointers with alpha channel, so if the callback does not support alpha, the pointer could be displayed as a normal color pointer. The AND mask is a 1-bpp bitmap with byte aligned scanlines. The size of the AND mask therefore iscbAnd = (width + 7) / 8 * height. The padding bits at the end of each scanline are undefined. The XOR mask follows the AND mask on the next 4-byte aligned offset:uint8_t *pXor = pAnd + (cbAnd + 3) & ~3. Bytes in the gap between the AND and the XOR mask are undefined. The XOR mask scanlines have no gap between them and the size of the XOR mask is:cXor = width * 4 * height. NOTE: If shape is 0, only the pointer visibility is changed.

Returns:
byte[]

queryInterface

public static IMousePointerShapeChangedEvent queryInterface(IUnknown obj)