Contents

convertCursorImage

Utility method of IOFramebuffer to convert cursor image to a hardware cursor format.

Declaration

virtual bool convertCursorImage(
 void *cursorImage, 
 IOHardwareCursorDescriptor *description, 
 IOHardwareCursorInfo *cursor );

Parameters

  • cursorImage:

    Opaque cursor parameter from the setCursorImage() call.

  • description:

    Describes the cursor format supported by the driver.

  • cursor:

    Structure describing the drivers allocated buffer to receive the converted image.

Return Value

a bool indicating the conversion was successful.

Overview

IOFramebuffer subclasses may implement hardware cursor functionality, if so they should pass the cursor image given by the setCursorImage() method, with a description of their hardware cursor format, to this helper function to this routine to convert the image to one suitable for the hardware.

See Also

Miscellaneous