Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetCompatibleFormat

Obsolete. Use the overload with a GraphicsFormatUsage parameter instead.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

GetCompatibleFormat(GraphicsFormat, FormatUsage)

Obsolete. Use the overload with a GraphicsFormatUsage parameter instead.
Warning
Deprecated. Use overload with a GraphicsFormatUsage parameter instead
public static GraphicsFormat GetCompatibleFormat(GraphicsFormat format, FormatUsage usage)

Parameters

Returns

Type

Description

GraphicsFormat

GetCompatibleFormat(GraphicsFormat, GraphicsFormatUsage)

Returns a format supported by the platform for the specified usage.
public static GraphicsFormat GetCompatibleFormat(GraphicsFormat format, GraphicsFormatUsage usage)

Parameters

The GraphicsFormat format to look up.

The GraphicsFormatUsage usage to look up.

Returns

Type

Description

GraphicsFormatReturns a format supported by the platform. If no equivalent or compatible format is supported, the function returns GraphicsFormat.None.

Remarks

If the platform supports the specified format for the usage, this method returns the input format. Otherwise, the method searches for a supported format with similar properties to the input format. If the platform doesn't support any similar format, the method returns a fallback format. For example, if the input format is a compressed format that isn't supported, the function returns an uncompressed equivalent format. If the platform doesn't support any equivalent or compatible fallback formats, this method returns GraphicsFormat.None.
Additional Resources: GraphicsFormat enum and GraphicsFormatUsage flags.