---
title: getPixelInformation
framework: kernel
role: pseudoSymbol
path: kernel/ioframebuffer/1813353-getpixelinformation
---

# getPixelInformation

Return information about the framebuffer format for a given display mode and depth.

## Declaration

```occ
virtual IOReturn getPixelInformation( 
 IODisplayModeID displayMode,
 IOIndex depth, 
 IOPixelAperture aperture,
 IOPixelInformation *pixelInfo ) = 0; 
```

## Parameters

- `displayMode`: A display mode ID previously returned by getDisplayModes().
- `depth`: An index from zero to the value of the maxDepthIndex field from the IODisplayModeInformation structure (inclusive).
- `info`: Pointer to a structure of type IOPixelInformation to be filled out by the driver. IOPixelInformation is documented in IOGraphicsTypes.h.

## Return Value

Return Value an IOReturn code. A return other than kIOReturnSuccess will prevent the system from using the device.

## Overview

Overview IOFramebuffer subclasses must implement this method to return information in the IOPixelInformation structure for the display mode with the passed ID, depth index and aperture. The aperture utilized by the system is always kIOFBSystemAperture. Drivers may define alternative apertures, being a view of the framebuffer in a different pixel format from the default.

## See Also

### Miscellaneous

- [connectFlags](kernel/ioframebuffer/1812972-connectflags.md)
- [convertCursorImage](kernel/ioframebuffer/1812983-convertcursorimage.md)
- [doI2CRequest](kernel/ioframebuffer/1812996-doi2crequest.md)
- [enableController](kernel/ioframebuffer/1813011-enablecontroller.md)
- [flushCursor](kernel/ioframebuffer/1813022-flushcursor.md)
- [getApertureRange](kernel/ioframebuffer/1813036-getaperturerange.md)
- [getAppleSense](kernel/ioframebuffer/1813053-getapplesense.md)
- [getAttribute](kernel/ioframebuffer/1813070-getattribute.md)
- [getAttributeForConnection](kernel/ioframebuffer/1813093-getattributeforconnection.md)
- [getConnectionCount](kernel/ioframebuffer/1813110-getconnectioncount.md)
- [getCurrentDisplayMode(IODisplayModeID *, IOIndex *)](kernel/ioframebuffer/1813145-getcurrentdisplaymode.md)
- [getDDCBlock](kernel/ioframebuffer/1813183-getddcblock.md)
- [getDisplayModeCount](kernel/ioframebuffer/1813210-getdisplaymodecount.md)
- [getDisplayModes](kernel/ioframebuffer/1813237-getdisplaymodes.md)
- [getInformationForDisplayMode](kernel/ioframebuffer/1813269-getinformationfordisplaymode.md)
- [getPixelFormats](kernel/ioframebuffer/1813303-getpixelformats.md)
- [getPixelFormatsForDisplayMode](kernel/ioframebuffer/1813329-getpixelformatsfordisplaymode.md)
- [getStartupDisplayMode](kernel/ioframebuffer/1813382-getstartupdisplaymode.md)
- [getTimingInfoForDisplayMode](kernel/ioframebuffer/1813413-gettiminginfofordisplaymode.md)
- [getVRAMRange](kernel/ioframebuffer/1813443-getvramrange.md)
- [handleEvent](kernel/ioframebuffer/1813481-handleevent.md)
- [hasDDCConnect](kernel/ioframebuffer/1813510-hasddcconnect.md)
- [readDDCClock](kernel/ioframebuffer/1813550-readddcclock.md)
- [readDDCData](kernel/ioframebuffer/1813593-readddcdata.md)
- [registerForInterruptType](kernel/ioframebuffer/1813622-registerforinterrupttype.md)
- [setApertureEnable](kernel/ioframebuffer/1813646-setapertureenable.md)
- [setAttribute](kernel/ioframebuffer/1813661-setattribute.md)
- [setAttributeForConnection](kernel/ioframebuffer/1813672-setattributeforconnection.md)
- [setCLUTWithEntries](kernel/ioframebuffer/1813680-setclutwithentries.md)
- [setCurrentDisplayMode](kernel/ioframebuffer/1813685-setcurrentdisplaymode.md)
- [setCursorImage](kernel/ioframebuffer/1813692-setcursorimage.md)
- [setCursorState](kernel/ioframebuffer/1813699-setcursorstate.md)
- [setDDCClock](kernel/ioframebuffer/1813707-setddcclock.md)
- [setDDCData](kernel/ioframebuffer/1813718-setddcdata.md)
- [setDetailedTimings](kernel/ioframebuffer/1813724-setdetailedtimings.md)
- [setDisplayMode](kernel/ioframebuffer/1813732-setdisplaymode.md)
- [setGammaTable](kernel/ioframebuffer/1813739-setgammatable.md)
- [setInterruptState](kernel/ioframebuffer/1813744-setinterruptstate.md)
- [setStartupDisplayMode](kernel/ioframebuffer/1813749-setstartupdisplaymode.md)
- [unregisterInterrupt(void *)](kernel/ioframebuffer/1813753-unregisterinterrupt.md)
- [unregisterInterrupt(void *, UInt32)](kernel/ioframebuffer/1813757-unregisterinterrupt.md)
- [validateDetailedTiming](kernel/ioframebuffer/1813761-validatedetailedtiming.md)