←Select platform

GetYUVData(RasterYUVFormat,byte[],int,int) Method

Converts the RasterImage grayscale or BGR data to YUV and stores it in an output buffer.
public int GetYUVData( 
   RasterYUVFormat yuvFormat, 
   byte[] buffer, 
   int bufferIndex, 
   int bufferCount 
Public Overloads Function GetYUVData( _ 
   ByVal yuvFormat As RasterYUVFormat, _ 
   ByVal buffer() As Byte, _ 
   ByVal bufferIndex As Integer, _ 
   ByVal bufferCount As Integer _ 
) As Integer 
int GetYUVData(  
   RasterYUVFormat yuvFormat, 
   array<byte>^ buffer, 
   int bufferIndex, 
   int bufferCount 


Specifies the YUV data format.

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.

The zero-based index into the buffer where the set operation should start.

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.


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); 


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


Target Platforms

Help Version 21.0.2021.3.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly