SetOverlayImage Method

Summary

Sets the "Overlay Data" (60xx,3000) for a certain overlay index.

Syntax

C++

Java

public void SetOverlayImage( 
   int index, 
   RasterImage overlayImage 
)

Public Sub SetOverlayImage( _ 
   ByVal index As Integer, _ 
   ByVal overlayImage As RasterImage _ 
)

public void setOverlayImage(int index, RasterImage image)

public: 
void SetOverlayImage(  
   int index, 
   RasterImage^ overlayImage 
)

Parameters

index
The zero-based index of the overlay being affected.

overlayImage
Image which will be used to update the overlay data. Cannot be null.

Remarks

This method will update the stream of bytes under the "Overlay Data" (60xx, 3000) element with the data in the passed image. This method will fail if the image width does not match the "Overlay Columns" (60xx, 0011) or if the image height does not match the "Overlay Rows" (60xx, 0011) for the overlay being updated.

Example

For an example, refer to OverlayCount.

Requirements

Target Platforms