JavaFX 27 · com.sun.prism.impl.QueuedPixelSource · APIdia, the JavaDoc alternative

Base concrete implementation of the PixelSource interface which manages Pixels objects in the state of being consumed (uploaded to the screen usually), in flight in the queue of upload requests, and idle waiting to be reused for temporary storage for future uploads. All Pixels objects currently saved for reuse will all be the same dimensions and scale which are tracked by calling the validate() method.

At most we will need 3 sets of pixels: One may be "in use", a hard reference stored in beingConsumed Another may be "in the queue", hard ref stored in enqueued A third may be needed to prepare new pixels while those two are in transit. If the third is filled with pixels and enqueued while the previously mentioned two are still in their stages of use, then it will replace the second object as the "enqueued" reference and the previously enqueued object will then become itself the "third unused" reference. If everything happens in lock step we will often have only one set of pixels. If the consumer/displayer gets slightly or occasionally behind we might end up with two sets of pixels in play. Only when things get really bad with multiple deliveries enqueued during the processing of a single earlier delivery will we end up with three sets of Pixels objects in play.

Field Summary

Modifier and Type	Field and Description
private volatile Pixels	beingConsumed
private volatile Pixels	enqueued
private final List<WeakReference<Pixels>>	saved
private final boolean	useDirectBuffers

Constructor Summary

Access	Constructor and Description
public	QueuedPixelSource(boolean useDirectBuffers)

Method Summary

Modifier and Type	Method and Description
public synchronized void	doneWithPixels(Pixels used) Implements com.sun.prism.PixelSource.doneWithPixels. Indicates that the specified non-null `Pixels` object which was obtained from `getLatestPixels()` is done being processed and can be reused for future pixel deliveries if needed.
public synchronized void	enqueuePixels(Pixels the `Pixels` object to be enqueued pixels) Place the indicated `Pixels` object into the enqueued state, replacing any other objects that are currently enqueued but not yet being used by the consumer.
public synchronized Pixels	getLatestPixels() Implements com.sun.prism.PixelSource.getLatestPixels. Gets the next "latest" set of `Pixels` to be processed or displayed.
public synchronized Pixels	Returns: an unused `Pixels` object getUnusedPixels(int the width of the desired Pixels object w, int the height of the desired Pixels object h, float the horizontal scale of the desired Pixels object scalex, float the vertical scale of the desired Pixels object scaley) Return an unused Pixels with the indicated dimensions and scale.
public synchronized void	skipLatestPixels() Implements com.sun.prism.PixelSource.skipLatestPixels. A one step method for skipping a pixel delivery object in the case where the consumer is not ready to process any pixels.
private boolean	usesSameBuffer(Pixels p1, Pixels p2)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

beingConsumed	back to summary
private volatile Pixels beingConsumed

enqueued	back to summary
private volatile Pixels enqueued

saved	back to summary
private final List<WeakReference<Pixels>> saved

useDirectBuffers	back to summary
private final boolean useDirectBuffers

Constructor Detail

QueuedPixelSource	back to summary
public QueuedPixelSource(boolean useDirectBuffers)

Method Detail

doneWithPixels back to summary

doneWithPixels	back to summary
public synchronized void doneWithPixels(Pixels used) Implements com.sun.prism.PixelSource.doneWithPixels. Doc from com.sun.prism.PixelSource.doneWithPixels. Indicates that the specified non-null `Pixels` object which was obtained from `getLatestPixels()` is done being processed and can be reused for future pixel deliveries if needed. This method should be called by the consumer if and only if the call to `getLatestPixels()` returned a non-null object. Annotations @Override

public synchronized void doneWithPixels(Pixels used)

Implements com.sun.prism.PixelSource.doneWithPixels.

Doc from com.sun.prism.PixelSource.doneWithPixels.

Indicates that the specified non-null Pixels object which was obtained from getLatestPixels() is done being processed and can be reused for future pixel deliveries if needed. This method should be called by the consumer if and only if the call to getLatestPixels() returned a non-null object.

Annotations

@Override

enqueuePixels back to summary

enqueuePixels	back to summary
public synchronized void enqueuePixels(Pixels pixels) Place the indicated `Pixels` object into the enqueued state, replacing any other objects that are currently enqueued but not yet being used by the consumer. Parameters pixels:Pixels the `Pixels` object to be enqueued

public synchronized void enqueuePixels(Pixels pixels)

Place the indicated Pixels object into the enqueued state, replacing any other objects that are currently enqueued but not yet being used by the consumer.

Parameters

pixels:Pixels: the Pixels object to be enqueued

getLatestPixels back to summary

getLatestPixels	back to summary
public synchronized Pixels getLatestPixels() Implements com.sun.prism.PixelSource.getLatestPixels. Doc from com.sun.prism.PixelSource.getLatestPixels. Gets the next "latest" set of `Pixels` to be processed or displayed. This method is called by the consumer of Pixels objects. The return value may be null if the delivery request was obsoleted or superceded while in transit between the threads. The caller should call `doneWithPixels()` if and only if the return value was non-null. Annotations @Override

public synchronized Pixels getLatestPixels()

Implements com.sun.prism.PixelSource.getLatestPixels.

Doc from com.sun.prism.PixelSource.getLatestPixels.

Gets the next "latest" set of Pixels to be processed or displayed. This method is called by the consumer of Pixels objects. The return value may be null if the delivery request was obsoleted or superceded while in transit between the threads. The caller should call doneWithPixels() if and only if the return value was non-null.

Annotations

@Override

getUnusedPixels back to summary

getUnusedPixels	back to summary
public synchronized Pixels getUnusedPixels(int w, int h, float scalex, float scaley) Return an unused Pixels with the indicated dimensions and scale. The returned object may either be saved from a previous use, but currently not being consumed or in the queue. Or it may be an object that reuses a buffer from a previously used (but not active) `Pixels` object. Or it may be a brand new object. Parameters w:int the width of the desired Pixels object h:int the height of the desired Pixels object scalex:float the horizontal scale of the desired Pixels object scaley:float the vertical scale of the desired Pixels object Returns:Pixels an unused `Pixels` object

public synchronized Pixels getUnusedPixels(int w, int h, float scalex, float scaley)

Return an unused Pixels with the indicated dimensions and scale. The returned object may either be saved from a previous use, but currently not being consumed or in the queue. Or it may be an object that reuses a buffer from a previously used (but not active) Pixels object. Or it may be a brand new object.

Parameters

w:int: the width of the desired Pixels object
h:int: the height of the desired Pixels object
scalex:float: the horizontal scale of the desired Pixels object
scaley:float: the vertical scale of the desired Pixels object

Returns:Pixels

an unused Pixels object

skipLatestPixels back to summary

skipLatestPixels	back to summary
public synchronized void skipLatestPixels() Implements com.sun.prism.PixelSource.skipLatestPixels. Doc from com.sun.prism.PixelSource.skipLatestPixels. A one step method for skipping a pixel delivery object in the case where the consumer is not ready to process any pixels. Examples of cases where this method is used is when deliveries are received for closed, iconified, or disposed windows. This call is equivalent to `doneWithPixels(getLatestPixels())`. Annotations @Override

public synchronized void skipLatestPixels()

Implements com.sun.prism.PixelSource.skipLatestPixels.

Doc from com.sun.prism.PixelSource.skipLatestPixels.

A one step method for skipping a pixel delivery object in the case where the consumer is not ready to process any pixels. Examples of cases where this method is used is when deliveries are received for closed, iconified, or disposed windows. This call is equivalent to doneWithPixels(getLatestPixels()).

Annotations

@Override

usesSameBuffer	back to summary
private boolean usesSameBuffer(Pixels p1, Pixels p2)

public Class QueuedPixelSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail