Skip to content

FadingGroup_AssignImageOverlay

function

Delphi
procedure FadingGroup_AssignImageOverlay (FadingGroupId: LongInt; ImageOverlayIndex: LongInt);
C++Builder
void __fastcall FadingGroup_AssignImageOverlay(System::LongInt FadingGroupId, System::LongInt ImageOverlayIndex);
C#
public void FadingGroup_AssignImageOverlay(int FadingGroupId, int ImageOverlayIndex);
VB.NET
Public Sub FadingGroup_AssignImageOverlay(FadingGroupId As Integer, ImageOverlayIndex As Integer)
C++/Qt
void FadingGroup_AssignImageOverlay (int FadingGroupId, int ImageOverlayIndex);

Assigns the image overlay identified by ImageOverlayIndex to the fading group. The overlay then fades (alpha modulation) in synchronization with the other members of the group.

ImageOverlayIndex is the index of the image overlay (0 for the 1st image overlay, 1 for the 2nd, etc.), i.e. the Index passed to SetImageOverlayFromImageFile2 and SetImageOverlay_Enabled. No function creates an image overlay: the overlay is loaded with SetImageOverlayFromImageFile2 (or another SetImageOverlayFrom... function taking the index as the first parameter) and displayed once enabled with SetImageOverlay_Enabled.

A given overlay belongs to at most one fading group: assigning it to another group removes it from the previous one.

E.g., fading of the 1st image overlay (index 0):

VideoGrabber.SetImageOverlayFromImageFile2 (0, 'logo.png');

VideoGrabber.SetImageOverlay_Enabled (0, true);

FadingGroupId := VideoGrabber.FadingGroup_Create (1500);

VideoGrabber.FadingGroup_AssignImageOverlay (FadingGroupId, 0);

VideoGrabber.FadingGroup_FadeOut (FadingGroupId);

See the Fading groups chapter.