Error Codes

Navigation: SDK → Host

Error Codes

Error codes returned from FidelityFX SDK functions.

Defines

FFX_RETURN_ON_ERROR

#define FFX_RETURN_ON_ERROR(x, y)     if (!(x))                                       \
    &#123;                                               \
        return (y);                                 \
    &#125;

Helper macro to return error code y from a function when a specific condition, x, is not met.

Source: sdk/include/FidelityFX/host/ffx_error.h (line 66, column 9)

FFX_VALIDATE

#define FFX_VALIDATE(x)     &#123;                                               \
        FfxErrorCode ret = x;                       \
        FFX_RETURN_ON_ERROR(ret == FFX_OK, ret);    \
    &#125;

Helper macro to return error code x from a function when it is not FFX_OK.

Source: sdk/include/FidelityFX/host/ffx_error.h (line 75, column 9)

Typedefs

FfxErrorCode

typedef int32_t FfxErrorCode

Typedef for error codes returned from functions in the FidelityFX SDK.

Source: sdk/include/FidelityFX/host/ffx_error.h (line 35, column 17)

Enumerations

FfxErrorCodes

enum FfxErrorCodes

Error codes and their meaning.

Values:

FFX_OK

FFX_OK = 0

The operation completed successfully.

FFX_ERROR_INVALID_POINTER

FFX_ERROR_INVALID_POINTER = 0x80000000

The operation failed due to an invalid pointer.

FFX_ERROR_INVALID_ALIGNMENT

FFX_ERROR_INVALID_ALIGNMENT = 0x80000001

The operation failed due to an invalid alignment.

FFX_ERROR_INVALID_SIZE

FFX_ERROR_INVALID_SIZE = 0x80000002

The operation failed due to an invalid size.

FFX_EOF

FFX_EOF = 0x80000003

The end of the file was encountered.

FFX_ERROR_INVALID_PATH

FFX_ERROR_INVALID_PATH = 0x80000004

The operation failed because the specified path was invalid.

FFX_ERROR_EOF

FFX_ERROR_EOF = 0x80000005

The operation failed because end of file was reached.

FFX_ERROR_MALFORMED_DATA

FFX_ERROR_MALFORMED_DATA = 0x80000006

The operation failed because of some malformed data.

FFX_ERROR_OUT_OF_MEMORY

FFX_ERROR_OUT_OF_MEMORY = 0x80000007

The operation failed because it ran out memory.

FFX_ERROR_INCOMPLETE_INTERFACE

FFX_ERROR_INCOMPLETE_INTERFACE = 0x80000008

The operation failed because the interface was not fully configured.

FFX_ERROR_INVALID_ENUM

FFX_ERROR_INVALID_ENUM = 0x80000009

The operation failed because of an invalid enumeration value.

FFX_ERROR_INVALID_ARGUMENT

FFX_ERROR_INVALID_ARGUMENT = 0x8000000a

The operation failed because an argument was invalid.

FFX_ERROR_OUT_OF_RANGE

FFX_ERROR_OUT_OF_RANGE = 0x8000000b

The operation failed because a value was out of range.

FFX_ERROR_NULL_DEVICE

FFX_ERROR_NULL_DEVICE = 0x8000000c

The operation failed because a device was null.

FFX_ERROR_BACKEND_API_ERROR

FFX_ERROR_BACKEND_API_ERROR = 0x8000000d

The operation failed because the backend API returned an error code.

FFX_ERROR_INSUFFICIENT_MEMORY

FFX_ERROR_INSUFFICIENT_MEMORY = 0x8000000e

The operation failed because there was not enough memory.

FFX_ERROR_INVALID_VERSION

FFX_ERROR_INVALID_VERSION = 0x8000000f

The operation failed because the wrong backend was linked.

FFX_ERROR_ACCESS_DENIED

FFX_ERROR_ACCESS_DENIED = 0x80000010

The operation failed because access to the resource was denied.

Source: sdk/include/FidelityFX/host/ffx_error.h (line 40, column 1)