org.virtualbox_5_1
Class IMousePointerShape

java.lang.Object
  extended by org.virtualbox_5_1.IUnknown
      extended by org.virtualbox_5_1.IMousePointerShape

public class IMousePointerShape
extends IUnknown

The guest mouse pointer description. Interface ID: {E04E5545-4A0F-F9D2-5BEF-F9B25B6557ED}


Field Summary
 
Fields inherited from class org.virtualbox_5_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IMousePointerShape(java.lang.String wrapped, org.virtualbox_5_1.ObjectRefManager objMgr, org.virtualbox_5_1.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.
 java.lang.Long getHotX()
          The pointer hot spot X coordinate.
 java.lang.Long getHotY()
          The pointer hot spot Y coordinate.
 byte[] getShape()
          Shape bitmaps.
 java.lang.Boolean getVisible()
          Flag whether the pointer is visible.
 java.lang.Long getWidth()
          Width of the pointer shape in pixels.
static IMousePointerShape queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_5_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

IMousePointerShape

public IMousePointerShape(java.lang.String wrapped,
                          org.virtualbox_5_1.ObjectRefManager objMgr,
                          org.virtualbox_5_1.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

getHotX

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

Returns:
Long

getHotY

public java.lang.Long getHotY()
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 bitmaps. The shape buffer contains a 1bpp (bits per pixel) AND mask followed by a 32bpp 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 provided for pointers with alpha channel, so if the client does not support alpha, the pointer could be displayed as a normal color pointer. The AND mask is a 1bpp 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 *pu8Xor = pu8And + (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:cbXor = width * 4 * height. NOTE: If shape size is 0, then the shape is not known or did not change. This can happen if only the pointer visibility is changed.

Returns:
byte[]

queryInterface

public static IMousePointerShape queryInterface(IUnknown obj)