PCL
Functions
Readout Notification Functions

Functions

virtual void pcl::ProcessInterface::BeginReadout (const View &view)
 
virtual void pcl::ProcessInterface::EndReadout (const View &view)
 
virtual void pcl::ProcessInterface::UpdateReadout (const View &view, const DPoint &position, double R, double G, double B, double A)
 

Detailed Description

The PixInsight core application calls readout notification functions to send real-time readout pixel values to interfaces.

Readout operations take place when the user clicks and drags the mouse over a view in readout mode (ImageMode::Readout). During a readout procedure, RGBA values are read from a view's image (according to global readout options) and sent to interfaces via readout notifications.

For example, an interface can receive readout notifications to let the user select a color by clicking directly over an image. The NewImage standard interface does exactly this to select an initial color for newly created images.

For a process interface to receive readout notifications, the corresponding ProcessInterface subclass must reimplement ProcessInterface::WantsReadoutNotifications() to return true.

Function Documentation

◆ BeginReadout()

virtual void pcl::ProcessInterface::BeginReadout ( const View &  view)
inlinevirtual

Notification sent to signal the beginning of a new readout procedure.

Parameters
viewReference to a view from which new readout data notifications will be sent from now on.
See also
Readout Notification Functions

Definition at line 2140 of file ProcessInterface.h.

◆ EndReadout()

virtual void pcl::ProcessInterface::EndReadout ( const View &  view)
inlinevirtual

Notification sent to signal the end of an active readout procedure.

Parameters
viewReference to the view from which new readout data notifications will no longer be sent.
See also
Readout Notification Functions

Definition at line 2175 of file ProcessInterface.h.

◆ UpdateReadout()

virtual void pcl::ProcessInterface::UpdateReadout ( const View &  view,
const DPoint &  position,
double  R,
double  G,
double  B,
double  A 
)
inlinevirtual

Notification sent when new readout data are available.

Parameters
viewReference to a view from which new readout data is being sent.
positionReadout position in image coordinates.
R,G,B,ANew readout red, green, blue and alpha values, respectively, in the normalized real range [0,1].
Note
Although images can have an unlimited number of alpha channels in PixInsight, only readout values from the first alpha channel (which defines transparency) are sent to interfaces.
See also
Readout Notification Functions

Definition at line 2162 of file ProcessInterface.h.