org.virtualbox_4_3

Class IFramebuffer

java.lang.Object

org.virtualbox_4_3.IUnknown

org.virtualbox_4_3.IFramebuffer

Direct Known Subclasses:

IFramebufferOverlay

public class IFramebuffer
extends IUnknown

Field Summary

Fields inherited from class org.virtualbox_4_3.IUnknown

obj, port

Constructor Summary

Constructors

Constructor and Description
IFramebuffer(java.lang.String wrapped, org.virtualbox_4_3.jaxws.VboxPortType port)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getBitsPerPixel() Color depth, in bits per pixel.
java.lang.Long	getBytesPerLine() Scan line size, in bytes.
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.
java.lang.Long	getPixelFormat() Frame buffer pixel format.
java.lang.Boolean	getUsesGuestVRAM() Defines whether this frame buffer uses the virtual video card's memory buffer (guest VRAM) directly or not.
java.lang.Long	getWidth() Frame buffer width, in pixels.
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_4_3.IUnknown

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_4_3.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. When getPixelFormat()is FramebufferPixelFormat.FOURCC_RGB, valid values are: 8, 15, 16, 24 and 32.

Returns:

Long

getBytesPerLine

public java.lang.Long getBytesPerLine()

Scan line size, in bytes. When getPixelFormat()is FramebufferPixelFormat.FOURCC_RGB, the size of the scan line must be aligned to 32 bits.

Returns:

Long

getPixelFormat

public java.lang.Long getPixelFormat()

Frame buffer pixel format. It's either one of the values defined by FramebufferPixelFormator a raw FOURCC code. NOTE: This attribute must never (and will never) return FramebufferPixelFormat.Opaque-- the format of the frame buffer must be always known.

Returns:

Long

getUsesGuestVRAM

public java.lang.Boolean getUsesGuestVRAM()

Defines whether this frame buffer uses the virtual video card's memory buffer (guest VRAM) directly or not.

Returns:

Boolean

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_4_3.IFramebufferOverlay

queryInterface

public static IFramebuffer queryInterface(IUnknown obj)

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.