All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.image.ImageDescription

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.util.QTHandleRef
                   |
                   +----quicktime.std.movies.media.SampleDescription
                           |
                           +----quicktime.std.image.ImageDescription

public class ImageDescription

extends SampleDescription

implements QuickTimeLib

kNativeSize

This is the size (the number of bytes) that are required for this class

ImageDescription(int)

Create an ImageDescription structure

ImageDescription(PixMap)

Create an ImageDescription from a PixMap.

clone()

Implementation of Cloneable Interface.

fromGraphicsImporter(GraphicsImporter)

Determines the image description information.

fromImageCompressionDialog(ImageCompressionDialog, QDGraphics, QDRect)

Compresses a frame that is sourced by a PixMap from the supplied QDGraphics, returning the compressed data and an image description.

fromSprite(Sprite)

This method gets the image description property of this sprite.

getBounds()

Return a QDRect that describes the width and height of the Image the description describes.

getClutID()

Return ID number of the color table for image.

getCTable()

Get the custom color table for an image.

getCType()

Return the compressor creator type.

getDataSize()

Return the size of the compressed image.

getDepth()

Return pixel depth of source image.

getEndianDescriptor()

Returns the EndianDescriptor for this class.

getExtension(int, int)

Obtain the extended data for an image.

getFrameCount()

Return number of frames in image data.

getHeight()

Return the height of the source image.

getHRes()

Return the horizontal resolution of the source image.

getIdSize()

Return the total size of this structure.

getJavaDefaultPixelDescription(int, int)

Create an ImageDescription structure that describes the default Java pixel format.

getName()

Return name of the compression algorithm.

getRevisionLevel()

Return the revision level.

getSpatialQuality()

Return the Spatial Quality.

getTemporalQuality()

Return the temporal Quality.

getVendor()

Return the vendor.

getVersion()

Return the version of compressed data.

getVRes()

Return the vertical resolution of the source image.

getWidth()

Return the width of the source image.

newGWorld(int)

Creates an offscreen QDGraphics object from the width, height, depth, and color table of a specified image description structure.

setClutID(int)

Set the id number of the color table.

setCTable(ColorTable)

Update the custom color table for an image.

setCType(int)

Set the compressor creator type.

setDataSize(int)

Set the data size.

setDepth(int)

Set the pixel depth.

setFrameCount(int)

Set the frame count.

setHeight(int)

Set height of source image in pixels.

setHRes(float)

Set horizontal resolution.

setName(String)

Set the name of the compression algorithm.

setRevisionLevel(int)

Set the revision level.

setSpatialQuality(int)

Set spatial quality.

setTemporalQuality(int)

Set temporal quality.

setVendor(int)

Set the vendor.

setVersion(int)

Set the version.

setVRes(float)

Set vertical resolution.

setWidth(int)

Set width of source image in pixels.

toString()

Returns the String representation of this Image Description.

 public static final int kNativeSize

This is the size (the number of bytes) that are required for this class

 public ImageDescription(int format) throws QTException

Create an ImageDescription structure

Parameters:

format - the dataFormat

 public ImageDescription(PixMap pixmap) throws QTException

Create an ImageDescription from a PixMap.

QuickTime::MakeImageDescriptionForPixMap

Parameters:

pixmap - the PixMap from which the imageDescription will be made

 public static EndianDescriptor getEndianDescriptor()

Returns the EndianDescriptor for this class.

Returns:

an EndianDescriptor

 public static ImageDescription fromGraphicsImporter(GraphicsImporter gi) throws StdQTException

Determines the image description information.

QuickTime::GraphicsImportGetImageDescription

See Also:

getImageDescription

 public static ImageDescription fromSprite(Sprite s) throws StdQTException

This method gets the image description property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the image description.

See Also:

getImageDescription

 public static QTImage fromImageCompressionDialog(ImageCompressionDialog icd,
                                                  QDGraphics src,
                                                  QDRect srcRect) throws QTException

Compresses a frame that is sourced by a PixMap from the supplied QDGraphics, returning the compressed data and an image description.

QuickTime::SCCompressImage()

Parameters:

src - the source PixMap.

srcRect - you can specify to compress just a part of the pix map by specifying a rectangle - or pass in null to compress the entire pix map.

Returns:

an image data object.

See Also:

compressImage

 public static ImageDescription getJavaDefaultPixelDescription(int width,
                                                               int height) throws QTException

Create an ImageDescription structure that describes the default Java pixel format. The Application must later set the data size that describes the image represented by this image description. This is typically the size returned from one of the Encoded image formats.

Parameters:

width - width of the image

height - height of image

 public Object clone()

Implementation of Cloneable Interface.

Overrides:

clone in class SampleDescription

 public void setCTable(ColorTable cTable) throws StdQTException

Update the custom color table for an image.

QuickTime::SetImageDescriptionCTable

Parameters:

cTable - a color table.

 public ColorTable getCTable() throws QTException

Get the custom color table for an image. If there is no CTable this returns null.

QuickTime::GetImageDescriptionCTable

Returns:

the ColorTable

 public int getExtension(int idType,
                         int index) throws StdQTException

Obtain the extended data for an image.

QuickTime::GetImageDescriptionExtension QuickTime::GetImageDescriptionExtension

Parameters:

idType - specifies the extension's type value.

index - specifies the extension's index value.

Returns:

a handle to the returned data.

 public QDGraphics newGWorld(int flags) throws QTException

Creates an offscreen QDGraphics object from the width, height, depth, and color table of a specified image description structure.

QuickTime::NewImageGWorld

Parameters:

flags - holding graphics world flags.

Returns:

a QDGraphics.

 public int getIdSize()

Return the total size of this structure.

 public int getCType()

Return the compressor creator type.

 public int getVersion()

Return the version of compressed data.

 public int getRevisionLevel()

Return the revision level.

 public int getVendor()

Return the vendor.

 public int getTemporalQuality()

Return the temporal Quality.

 public int getSpatialQuality()

Return the Spatial Quality.

 public int getWidth()

Return the width of the source image.

 public int getHeight()

Return the height of the source image.

 public QDRect getBounds()

Return a QDRect that describes the width and height of the Image the description describes.

 public float getHRes()

Return the horizontal resolution of the source image.

 public float getVRes()

Return the vertical resolution of the source image.

 public int getDataSize()

Return the size of the compressed image.

 public int getFrameCount()

Return number of frames in image data.

 public String getName() throws UtilException

Return name of the compression algorithm.

 public int getDepth()

Return pixel depth of source image.

 public int getClutID()

Return ID number of the color table for image.

 public void setCType(int cType)

Set the compressor creator type.

Parameters:

cType - a compressor type.

 public void setVersion(int version)

Set the version.

Parameters:

version - a version number.

 public void setRevisionLevel(int revision)

Set the revision level.

Parameters:

revision - a revision number.

 public void setVendor(int vendor)

Set the vendor.

Parameters:

vendor - a developer of the compressor.

 public void setTemporalQuality(int temporalQuality)

Set temporal quality.

Parameters:

temporalQuality - a degree of temporal compression.

 public void setSpatialQuality(int spatialQuality)

Set spatial quality.

Parameters:

a - degree of spatial compression.

 public void setWidth(int width)

Set width of source image in pixels.

Parameters:

width - the width of the source image in pixels.

 public void setHeight(int height)

Set height of source image in pixels.

Parameters:

height - the height of the source image in pixels.

 public void setHRes(float hRes)

Set horizontal resolution.

Parameters:

hRes - the horizontal resolution of the source image.

 public void setVRes(float vRes)

Set vertical resolution.

Parameters:

vRes - the vertical resolution of the source image.

 public void setDataSize(int dataSize)

Set the data size.

Parameters:

dataSize - the size of the compressed image.

 public void setFrameCount(int frameCount)

Set the frame count.

Parameters:

frameCount - the number of frames in the image data.

 public void setName(String name) throws UtilException

Set the name of the compression algorithm.

Parameters:

name - indicates the compression algorithm.

 public void setDepth(int depth)

Set the pixel depth.

Parameters:

depth - is the pixel depth specified for the compressed image.

 public void setClutID(int clutID)

Set the id number of the color table.

Parameters:

clutID - contains the ID of the color table for the compressed image.

 public String toString()

Returns the String representation of this Image Description.

Overrides:

toString in class SampleDescription

All Packages  Class Hierarchy  This Package  Previous  Next  Index