GetYUVData(RasterYUVFormat,IntPtr,long) Method

Summary

Converts the RasterImage grayscale or BGR data to YUV and stores it in an output buffer.

Syntax

C++

public long GetYUVData( 
   RasterYUVFormat yuvFormat, 
   IntPtr buffer, 
   long bufferCount 
)

Public Overloads Function GetYUVData( _ 
   ByVal yuvFormat As RasterYUVFormat, _ 
   ByVal buffer As IntPtr, _ 
   ByVal bufferCount As Long _ 
) As Long

public: 
int64 GetYUVData(  
   RasterYUVFormat yuvFormat, 
   IntPtr buffer, 
   int64 bufferCount 
)

Parameters

yuvFormat
Specifies the YUV data format.

buffer
Buffer to receive the YUV data. If NULL, this method will return the expected size of the YUV data buffer. If not NULL, the YUV data will be extracted and stored in buffer if the buffer is large enough to contain the YUV data.

bufferCount
Size of the data buffer pointed to by buffer. If this value is incorrect, this method will throw an exception.

Return Value

The expected size of the YUV data buffer.

Remarks

The user is responsible for allocating and freeing the YUV buffer when it is no longer needed.

The buffer should be large enough to store the data for the whole image. If the buffer is not large enough to store all the requested data, the method will throw and exception.

Note that in each case, the function ignores the ViewPerspective. So the YUV data will match the view perspective in the image. In other words, if the image's view perspective is BottomLeft, the YUV data you retrieve in the YUV buffer will be flipped. In most cases, you will want the YUV buffer to be correct side up, so you will want ViewPerspective to be TopLeft. You can use ChangeViewPerspective to make the bitmap be the correct ViewPerspective.

The YUV data will be in studio YUV format, which means the Y values will range from 16 to 235 and U, V values will range from 16 to 240. The Y values are unsigned, while U, V values are offset by 0x80. In other words, a value of 0x80 for U corresponds to a U value of 0 and a value of 0x7F corresponds to a U value of -1.

If you do not know the expected size of the YUV buffer, you can call the function twice, as follows: long dataSize = image.GetYUVData(RasterYUVFormat.NV12, IntPtr.Zero, 0L); Byte[] dataBuffer = new byte[size]; image.GetYUVData(RasterYUVFormat.YV12, yuvBuffer2, 0, yuvBuffer2.Length);

Example

For an example, see SetYUVData(byte/[/], int, int, RasterYUVFormat).

Requirements

Target Platforms