com.sun.dtv.ui
Class Capabilities

java.lang.Object
  com.sun.dtv.ui.Capabilities

public class Capabilities
extends Object

Describes the capabilities of a plane. Every plane object (i.e. an instance of a class subclassing the Plane class) has an associated instance of this class. This instance can be retrieved using the Plane.getCapabilities() method.

Method Summary

int	getBitsPerPixel() Indicates how many bits are used for coding of the pixels if images are rendered on the plane associated with this instance of Capabilities.
int	getColorCodingModel() Indicate the color coding model used by the plane associated with this instance of Capabilities.
Dimension[]	getSupportedPixelAspectRatios() Provide all pixel aspect ratios supported by the plane associated with this instance of Capabilities.
Dimension[]	getSupportedPlaneAspectRatios() Provide all plane aspect ratios supported by the plane associated with this instance of Capabilities.
Dimension[]	getSupportedScreenResolutions() Provide all screen sizes supported by the plane associated with this instance of Capabilities.
boolean	isAlphaBlendingSupported() Indicate whether alpha blending is supported by the plane associated with this instance of Capabilities.
boolean	isGIFRenderingSupported() Indicate whether the rendering of GIF images is supported for the plane associated with this instance of Capabilities.
boolean	isGraphicsRenderingSupported() Indicate whether graphics rendering is supported by the plane associated with this instance of Capabilities.
boolean	isImageRenderingSupported() Indicate whether the rendering of images is supported for the plane associated with this instance of Capabilities.
boolean	isJPEGRenderingSupported() Indicate whether the rendering of JPEG images is supported for the plane associated with this instance of Capabilities.
boolean	isPNGRenderingSupported() Indicate whether the rendering of PNG images is supported for the plane associated with this instance of Capabilities.
boolean	isRealAlphaBlendingSupported() Indicate whether real alpha blending is supported by the plane associated with this instance of Capabilities.
boolean	isVideoRenderingSupported() Indicate whether the rendering of videos is supported for the plane associated with this instance of Capabilities.
boolean	isWidgetRenderingSupported() Indicate whether widget rendering is supported by the plane associated with this instance of Capabilities.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSupportedScreenResolutions

public Dimension[] getSupportedScreenResolutions()

Provide all screen sizes supported by the plane associated with this instance of Capabilities.

Returns:

an array of all supported screen sizes

getSupportedPlaneAspectRatios

public Dimension[] getSupportedPlaneAspectRatios()

Provide all plane aspect ratios supported by the plane associated with this instance of Capabilities.

Returns:

an array of all supported screen aspect ratios

getSupportedPixelAspectRatios

public Dimension[] getSupportedPixelAspectRatios()

Provide all pixel aspect ratios supported by the plane associated with this instance of Capabilities.

Returns:

an array of all supported pixel aspect ratios

isAlphaBlendingSupported

public boolean isAlphaBlendingSupported()

Indicate whether alpha blending is supported by the plane associated with this instance of Capabilities. The return value is also true if the setup does not support real (hardware supported) alpha blending, but uses a so-called switching plane. This switching plane, offered by some implementations in order to spare hardware-supported alpha blending for video planes, is an additional plane with one bit per pixel, just indicating for every pixel whether this plane or the underlying plane should be visible.

To indicate whether real (hardware supported) alpha blending is available, the isRealAlphaBlendingSupported() method has to be called.

Returns:

true if alpha blending (realized by hardware support or by use of a switching plane) is supported, false otherwise

See Also:

isRealAlphaBlendingSupported()

isRealAlphaBlendingSupported

public boolean isRealAlphaBlendingSupported()

Indicate whether real alpha blending is supported by the plane associated with this instance of Capabilities. The return value is only true if the plane supports real (hardware supported) alpha blending. If alpha blending is just simulated by use of a so-called switching plane, the return value is false.

Returns:

true if real alpha blending (realized by hardware support, not by use of a switching plane) is supported, false otherwise

See Also:

isAlphaBlendingSupported()

isImageRenderingSupported

public boolean isImageRenderingSupported()

Indicate whether the rendering of images is supported for the plane associated with this instance of Capabilities. The return value could be true for setups suitable for graphics or video still planes, but false for a setup suitable for a subtitle plane.

Returns:

true if image rendering is supported, false otherwise

isJPEGRenderingSupported

public boolean isJPEGRenderingSupported()

Indicate whether the rendering of JPEG images is supported for the plane associated with this instance of Capabilities. The return value can only be true if the return value of isImageRenderingSupported(), called for the same object, is also true.

Returns:

true if JPEG image rendering is supported, false otherwise

isPNGRenderingSupported

public boolean isPNGRenderingSupported()

Indicate whether the rendering of PNG images is supported for the plane associated with this instance of Capabilities. The return value can only be true if the return value of isImageRenderingSupported(), called for the same object, is also true.

Returns:

true if PNG image rendering is supported, false otherwise

isGIFRenderingSupported

public boolean isGIFRenderingSupported()

Indicate whether the rendering of GIF images is supported for the plane associated with this instance of Capabilities. The return value can only be true if the return value of isImageRenderingSupported(), called for the same object, is also true.

Returns:

true if GIF image rendering is supported, false otherwise

isVideoRenderingSupported

public boolean isVideoRenderingSupported()

Indicate whether the rendering of videos is supported for the plane associated with this instance of Capabilities. The return value could be true for setups suitable for video planes, but false for a setup suitable for a background plane.

Returns:

true if video rendering is supported, false otherwise

getBitsPerPixel

public int getBitsPerPixel()
                    throws SetupException

Indicates how many bits are used for coding of the pixels if images are rendered on the plane associated with this instance of Capabilities. The call to this method makes only sense if image rendering is supported by this kind of plane, i.e. if the return value of isImageRenderingSupported() is true for this Capabilities object, otherwise an exception is thrown.

Returns:

the number of bits used for coding of one single pixel

Throws:

SetupException - if this method is called for an Capabilities object for which isImageRenderingSupported() returns false

getColorCodingModel

public int getColorCodingModel()
                        throws SetupException

Indicate the color coding model used by the plane associated with this instance of Capabilities. The return value is implementation dependent. Implementations are advised to define an enumeration containing values for all possible supported color coding models (e.g. YUV444, YUV422, YUV420, ARGB888 etc.) The call to this method makes only sense if at least one of the following methods, called for the same Capabilities object, returns true:

• isImageRenderingSupported()
• isWidgetRenderingSupported()
• isGraphicsRenderingSupported()

. Otherwise an exception is thrown.

Returns:

an implementation dependent value indicating which color coding model is used

Throws:

SetupException - if this method is called for a Capabilities object, for which all methods mentioned above return false

isWidgetRenderingSupported

public boolean isWidgetRenderingSupported()

Indicate whether widget rendering is supported by the plane associated with this instance of Capabilities. A plane, for which a DTVContainer will be requested by calling one of the DTVContainer.getDTVContainer(com.sun.dtv.ui.Plane) methods, must be associated with a Capabilities object for which this or the isGraphicsRenderingSupported() method returns true.

Returns:

true if widget rendering is supported, false otherwise

isGraphicsRenderingSupported

public boolean isGraphicsRenderingSupported()

Indicate whether graphics rendering is supported by the plane associated with this instance of Capabilities. A plane, for which a DTVContainer will be requested by calling one of the DTVContainer.getDTVContainer(com.sun.dtv.ui.Plane) methods, must be associated with a Capabilities object for which this or the isWidgetRenderingSupported() method returns true.

Returns:

true if graphics rendering is supported, false otherwise