DirectDrawSurface7.UpdateOverlayFx

The DirectDrawSurface7.UpdateOverlayFx method repositions or modifies the visual attributes of an overlay surface, using special overlay effects. These surfaces must have the DDSCAPS_OVERLAY flag set.

object.UpdateOverlayFx(RECT As RECT, _ 
    ddS As DirectDrawSurface7, _ 
    rectD As RECT, _ 
    flags As CONST_DDOVERFLAGS, _ 
    ddoverfx As DDOVERLAYFX)

Parameters

object

Object expression that resolves to a DirectDrawSurface7 object.

RECT

RECT type that defines the x, y, width, and height of the region on the source surface being used as the overlay. This parameter can be an empty RECT when hiding an overlay or to indicate that the entire overlay surface is to be used and the overlay surface conforms to any boundary and size alignment restrictions imposed by the device driver.

ddS

DirectDrawSurface7 object for the surface that is being overlaid.

rectD

RECT type that defines the x, y, width, and height of the region on the destination surface that the overlay should be moved to. This parameter can be an empty RECT when hiding the overlay.

flags

One or more constants of the CONST_DDOVERFLAGS enumeration. You must specify the DDOVER_DDFX flag to apply the effects set by the ddoverfx parameter.

ddoverfx

DDOVERLAYFX type describing additional effects to be applied to an overlay surface.

Error Codes

If the method fails, it raises an error, and Err.Number can be set to one of the following values: