Share via


ImageVariableDescriptorPreview.BitmapPixelFormat Property

Definition

Deprecated. Gets the pixel format of the image.

public:
 property BitmapPixelFormat BitmapPixelFormat { BitmapPixelFormat get(); };
BitmapPixelFormat BitmapPixelFormat();
/// [get: Windows.Foundation.Metadata.Deprecated("Use IImageFeatureDescriptor instead of IImageVariableDescriptorPreview. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 131072, "Windows.AI.MachineLearning.Preview.MachineLearningPreviewContract")]
BitmapPixelFormat BitmapPixelFormat();
public BitmapPixelFormat BitmapPixelFormat { get; }
public BitmapPixelFormat BitmapPixelFormat { [Windows.Foundation.Metadata.Deprecated("Use IImageFeatureDescriptor instead of IImageVariableDescriptorPreview. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 131072, "Windows.AI.MachineLearning.Preview.MachineLearningPreviewContract")] get; }
var bitmapPixelFormat = imageVariableDescriptorPreview.bitmapPixelFormat;
Public ReadOnly Property BitmapPixelFormat As BitmapPixelFormat

Property Value

Pixel format of the image.

Attributes

Examples

public void Evaluator(LearningModelPreview model)
{
	// Retrieve the first input feature which is an image
    ILearningModelVariableDescriptorPreview inputImageFeatureDescription = model.Description.InputFeatures.FirstOrDefault(feature=>feature.ModelFeatureKind == LearningModelFeatureKindPreview.Image);

    ImageVariableDescriptorPreview imageDescriptor = (ImageVariableDescriptorPreview)inputImageFeatureDescription;

	// Ensure the input feature handles the format RGBA8
    if (imageDescriptor.BitmapPixelFormat != BitmapPixelFormat.Rgba8)
    {
        Console.WriteLine($"Input Feature Name: {imageDescriptor.Name}. Format not supported.");
    }

 }

Remarks

Warning

This is a deprecated API. Please use the Windows.AI.MachineLearning namespace instead.

Applies to