XGameStreamingGetStreamPhysicalDimensions
Get the physical dimensions of the video stream as it renders on the streaming client.Syntax
Parameters
client _In_Type: XGameStreamingClientId The client to query the physical size of. horizontalMm _Out_
Type: uint32_t* The size in millimeters of the horizontal axis of the video stream. verticalMm _Out_
Type: uint32_t* The size in millimeters of the vertical axis of the video stream.
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code. Potential Errors
For a list of error codes, see Error Codes.
Remarks
You can use this method to determine whether the stream will be sent to a smaller device (for example, a smartphone). This allows you to present a more player friendly, device–appropriate experience (for example, by using a larger font size) based on the device size. If you want the game to respond to changes in the physical dimensions of the stream, then you should register a callback via XGameStreamingRegisterClientPropertiesChanged.Example
The following code example demonstrates how to use theXGameStreamingGetStreamPhysicalDimensions function to find the smallest dimensions for a streaming client.
Requirements
Header: xgamestreaming.h Library: xgameruntimelib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesSee also
XGameStreamingXGameStreamingRegisterClientPropertiesChanged
XGameStreaming
