XFrontPanelPresentBuffer

Renders the specified buffer to the front panel display.

Syntax

HRESULT XFrontPanelPresentBuffer(  
         uint32_t bufferSize,  
         const uint8_t* buffer  
)  

Parameters

bufferSize   _In_
Type: uint32_t

Size of the buffer, in bytes.

buffer   _In_reads_(bufferSize)
Type: uint8_t*

Pointer to an array of pixels to render to the screen.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an error code.

Remarks

Generally, call this function only when the front panel display needs to be updated. Calling it for every frame is needed only for animation.

To get the pixel format to use in buffer, use XFrontPanelGetScreenPixelFormat.

To get the dimensions of the front panel display, use XFrontPanelGetScreenDimensions.

For more information, see Xbox One X: Using the front panel display (NDA topic)Authorization required.

Requirements

Header: xfrontpaneldisplay.h

Library: xfrontpaneldisplay.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

XFrontPanelDisplay