Share via


INuiSensor::NuiImageFrameGetDepthImagePixelFrameTexture Method

Kinect for Windows 1.5, 1.6, 1.7, 1.8

Returns a pointer to an INuiFrameTexture that contains the data of a depth frame in NUI_DEPTH_IMAGE_PIXEL format (instead of packed USHORTs).

Syntax

public:
HRESULT NuiImageFrameGetDepthImagePixelFrameTexture(
         HANDLE hStream,
         NUI_IMAGE_FRAME *pImageFrame,
         BOOL *pNearMode,
         INuiFrameTexture **ppFrameTexture
)

Parameters

  • hStream
    Type: HANDLE
    A handle to the image stream.
  • pImageFrame
    Type: NUI_IMAGE_FRAME
    The NUI_IMAGE_FRAME for which the texture is being requested. This must be a valid frame returned by a call to NuiImageStreamGetNextFrame on hStream, and not yet released by a call to NuiImageStreamReleaseFrame.
  • pNearMode
    Type: BOOL
    Returns TRUE if the frame was captured in near mode; FALSE if it was captured in default mode.
  • ppFrameTexture
    Type: INuiFrameTexture
    Returns a pointer to an INuiFrameTexture containing the depth pixels. The lifetime of this texture is tied to the lifetime of pImageFrame; application code must not access the texture after NuiImageStreamRelease has been called on pImageFrame.

Return Value

Type: HRESULT
Returns S_OK if successful; otherwise, returns a failure code.

Requirements

Header: Declared in nuisensor.h.