GetOverlayImages Method

Summary

Loads the image(s) with frames from the "Overlay Data" (60xx, 3000) element.

Syntax

C++

Java

public RasterImage GetOverlayImages( 
   int index, 
   int overlayFrameIndex, 
   int count 
)

Public Overloads Function GetOverlayImages( _ 
   ByVal index As Integer, _ 
   ByVal overlayFrameIndex As Integer, _ 
   ByVal count As Integer _ 
) As RasterImage

public RasterImage getOverlayImages(int index, int overlayFrameIndex, int count)

public: 
RasterImage^ GetOverlayImages(  
   int index, 
   int overlayFrameIndex, 
   int count 
)

Parameters

index
The zero-based index of the overlay whose frames are required.

overlayFrameIndex
The zero-based index of the first frame to load.

count
Value that represents the number of frames to load.

Return Value

Image(s) with frames from the "Overlay Data" (60xx, 3000) element.

Remarks

Before calling this method, you must call GetOverlayAttributes. The FramesInOverlay property will be updated with the number of frames under an overlay. As an example, To load 5 frames starting with the 1st frame in the "Overlay Data", call this method with overlayFrameIndex set to 0 and count set to 5.

Example

For an example, refer to OverlayCount.

Requirements

Target Platforms