DiveBlitImage - Parameters

hDiveInst (HDIVE) - input

Display engine DIVE instance.

ulSrcBufNumber (ULONG) - input

Indicates DIVE instance buffer number of the buffer containing the source data. This value is returned by DiveAllocImageBuffer.

ulDstBufNumber (ULONG) - input

The following buffer numbers are reserved for blitting to the screen.

DIVE_BUFFER_SCREEN

Results in the image being transferred to either the graphics plane buffer or the alternate plane buffer, based on whether an alternate buffer exists and the suitability of the overlay plane to accelerate the scaling of the image. If DIVE chooses to use the alternate buffer, it will also paint the overlay "key" color on the graphics plane. This automatic painting does not occur if the alternate plane is explicitly specified.
DIVE_BUFFER_GRAPHICS_PLANE
Results in the image being transferred to the graphics plane.
DIVE_BUFFER_ALTERNATE_PLANE
Results in the image being transferred to the alternate (for example, overlay) plane. If your hardware does not support such a plane, this is an error.

rc (ULONG) - returns

Return codes indicating success or type of failure:

DIVE_SUCCESS

If the function succeeds, 0 is returned.
DIVE_ERR_ACQUIRE_FAILED
The acquire action did not complete successfully.
DIVE_ERR_BLITTER_NOT_SETUP
DiveSetupBlitter must be called before a call is made to DiveBlitImage.
DIVE_ERR_BUFFER_NOT_ACCESSED
The buffer has not been accessed (occurs on systems with accelerator-enabled hardware).
DIVE_ERR_FATAL_EXCEPTION
DIVE is unable to register the exception handler to handle bank switching.
DIVE_ERR_INVALID_INSTANCE
The DIVE instance handle specified in the hDiveInst parameter is invalid.

---

[Back: DiveBlitImage Return Value - rc]
[Next: DiveBlitImage - Remarks]