Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: awt ::
interface XImageConsumer
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XImageConsumer
Description specifies a data sink for an image. An image consumer is a component which wants to display or just receive an image from an image producer. See also XImageProducer

Methods' Summary
init | initializes the consumer with image dimensions.
setColorModel | changes color model for next pixels typically called once after initialization.
setPixelsByBytes | delivers a chunk of pixels as`long` values.
setPixelsByLongs | delivers a chunk of pixels as`byte` values.
complete | is called for the notification of the degree to which the image is delivered.

Methods' Details
init
[oneway] void init( | [in] long [in] long | Width, Height );
Description initializes the consumer with image dimensions.
setColorModel
[oneway] void setColorModel( | [in] short [in] sequence< long > [in] long [in] long [in] long [in] long | BitCount, RGBAPal, RedMask, GreenMask, BlueMask, AlphaMask );
Description changes color model for next pixels typically called once after initialization.
setPixelsByBytes
[oneway] void setPixelsByBytes( | [in] long [in] long [in] long [in] long [in] sequence< byte > [in] long [in] long | nX, nY, nWidth, nHeight, aProducerData, nOffset, nScanSize );
Description delivers a chunk of pixels as`long` values. The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * nScanSize + m + nOffset).
setPixelsByLongs
[oneway] void setPixelsByLongs( | [in] long [in] long [in] long [in] long [in] sequence< long > [in] long [in] long | nX, nY, nWidth, nHeight, aProducerData, nOffset, nScanSize );
Description delivers a chunk of pixels as`byte` values. The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the rectangle of source pixels that are contained in the array of pixels. The specified color model object should be used to convert the pixels into their corresponding color and alpha components. Pixel (m,n) is stored in the pixels array at index (n * nScanSize + m + nOffset).
complete
[oneway] void complete( | [in] long [in] XImageProducer | Status, xProducer );
Description is called for the notification of the degree to which the image is delivered. The complete method is called when the image producer has finished delivering all of the pixels that the source image contains, or when a single frame of a multi-frame animation has been completed, or when an error in loading or producing the image has occurred. The image consumer should remove itself from the list of consumers registered with the image producer at this time, unless it is interested in successive frames.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.