Atomic.h(3)

include/Zycore/Atomic.h(3)

Library Functions Manual

include/Zycore/Atomic.h(3)

NAME

include/Zycore/Atomic.h

SYNOPSIS

#include <Zycore/Defines.h>
#include <Zycore/Types.h>

Classes

struct ZyanAtomic32_
struct ZyanAtomic64_
struct ZyanAtomicPointer_

Macros

#define ZYAN_ATOMIC_COMPARE_EXCHANGE(destination, comparand, value)
#define ZYAN_ATOMIC_INCREMENT(destination)
#define ZYAN_ATOMIC_DECREMENT(destination)
#define ZYAN_ATOMIC_COMPARE_EXCHANGE32(destination, comparand, value)
#define ZYAN_ATOMIC_INCREMENT32(destination)
#define ZYAN_ATOMIC_DECREMENT32(destination)
#define ZYAN_ATOMIC_COMPARE_EXCHANGE64(destination, comparand, value)
#define ZYAN_ATOMIC_INCREMENT64(destination)
#define ZYAN_ATOMIC_DECREMENT64(destination)

Typedefs

typedef struct ZyanAtomic32_ ZyanAtomic32
typedef struct ZyanAtomic64_ ZyanAtomic64
typedef struct ZyanAtomicPointer_ ZyanAtomicPointer

Detailed Description

Cross compiler atomic intrinsics.

Macro Definition Documentation

#define ZYAN_ATOMIC_COMPARE_EXCHANGE( destination, comparand, value)

Value:



    ZyanAtomicCompareExchange((ZyanAtomicPointer*)&(destination), (comparand), (value))

Compares two values for equality and, if they are equal, replaces the first value.

Parameters

destination A pointer to the destination value.
comparand The value to compare with.
value The replacement value.

Returns

The original value.

#define ZYAN_ATOMIC_COMPARE_EXCHANGE32( destination, comparand, value)

Value:



    ZyanAtomicCompareExchange32((ZyanAtomic32*)&(destination), (comparand), (value))

Compares two values for equality and, if they are equal, replaces the first value.

Parameters

destination A pointer to the destination value.
comparand The value to compare with.
value The replacement value.

Returns

The original value.

#define ZYAN_ATOMIC_COMPARE_EXCHANGE64( destination, comparand, value)

Value:



    ZyanAtomicCompareExchange64((ZyanAtomic64*)&(destination), (comparand), (value))

Compares two values for equality and, if they are equal, replaces the first value.

Parameters

destination A pointer to the destination value.
comparand The value to compare with.
value The replacement value.

Returns

The original value.

#define ZYAN_ATOMIC_DECREMENT( destination)

Value:



    ZyanAtomicDecrement((ZyanAtomicPointer*)&(destination));

Decrements the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The decremented value.

#define ZYAN_ATOMIC_DECREMENT32( destination)

Value:



    ZyanAtomicDecrement32((ZyanAtomic32*)&(destination));

Decrements the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The decremented value.

#define ZYAN_ATOMIC_DECREMENT64( destination)

Value:



    ZyanAtomicDecrement64((ZyanAtomic64*)&(destination));

Decrements the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The decremented value.

#define ZYAN_ATOMIC_INCREMENT( destination)

Value:



    ZyanAtomicIncrement((ZyanAtomicPointer*)&(destination));

Increments the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The incremented value.

#define ZYAN_ATOMIC_INCREMENT32( destination)

Value:



    ZyanAtomicIncrement32((ZyanAtomic32*)&(destination));

Increments the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The incremented value.

#define ZYAN_ATOMIC_INCREMENT64( destination)

Value:



    ZyanAtomicIncrement64((ZyanAtomic64*)&(destination));

Increments the given value and stores the result, as an atomic operation.

Parameters

destination A pointer to the destination value.

Returns

The incremented value.

Author

Generated automatically by Doxygen for Zycore from the source code.

Version 1.5.2.0

Zycore