hDiveInst (HDIVE) - input
Display
engine DIVE instance.
pSetupBlitter (PSETUP_BLITTER)
- input
Pointer to SETUP_BLITTER.
This data structure contains parameters that will be used during the subsequent
DiveBlitImage call. If this pointer
is zero on input, this function will deinitialize the blitter and subsequent
calls to DiveBlitImage will return
DIVE_ERR_BLITTER_NOT_SETUP.
The ulStructLen field specifies the number of fields that are valid
on input. Fields that are not specified as valid on input are considered
to be unchanged from previous calls to DiveSetupBlitter. For example, if
the visible rectangles have not changed, the structure length can be set
to exclude the ulNumDstRects and pVisDstRects fields of SETUP_BLITTER,
thereby enabling a performance optimization in the function.
rc (ULONG) - returns
Return
codes indicating success or type of failure:
DIVE_SUCCESS
If the function succeeds, 0 is returned.
DIVE_ERR_INVALID_CONVERSION
The
source image format cannot be converted as requested to the destination
image format.
DIVE_ERR_INVALID_INSTANCE
The
DIVE instance handle specified in the hDiveInst parameter is invalid.
DIVE_ERR_SOURCE_FORMAT
The
source format is not a recognized FOURCC.
DIVE_WARN_NO_SIZE
No blitting will occur because either the destination
width or height is zero.
[Back: DiveSetupBlitter Return Value - rc]
[Next: DiveSetupBlitter - Remarks]