platform/apple/Apple.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_PLATFORM_APPLE_APPLE_H
#define META_OCEAN_PLATFORM_APPLE_APPLE_H
 
#include "ocean/platform/Platform.h"
 
#include "ocean/base/ScopedObject.h"
 
#ifndef OCEAN_PLATFORM_BUILD_APPLE
    #error This library is available on Apple platforms only!
#endif
 
#include <CoreFoundation/CoreFoundation.h>
 
#include <CoreGraphics/CoreGraphics.h>
 
namespace Ocean
{
 
namespace Platform
{
 
namespace Apple
{
 
/**
 * @ingroup platform
 * @defgroup platformapple Ocean Platform Apple Library
 * @{
 * The Ocean Apple Library provides specific functionalities for Apple platforms.
 * The library is available on Apple platforms only.
 * @}
 */
 
/**
 * @namespace Ocean::Platform::Apple Namespace of the Platform Apple library.<p>
 * The Namespace Ocean::Platform::Apple is used in the entire Ocean Platform Apple Library.
 */
 
/**
 * Definition of a scoped object holding a CFStringRef object.
 * The wrapped CFStringRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFStringRef = ScopedObjectCompileTimeT<CFStringRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CFURLRef object.
 * The wrapped CFURLRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFURLRef = ScopedObjectCompileTimeT<CFURLRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CFDataRef object.
 * The wrapped CFDataRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFDataRef = ScopedObjectCompileTimeT<CFDataRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CFMutableDataRef object.
 * The wrapped CFMutableDataRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFMutableDataRef = ScopedObjectCompileTimeT<CFMutableDataRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CGImageRef object.
 * The wrapped CGImageRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCGImageRef = ScopedObjectCompileTimeVoidT<CGImageRef, CGImageRelease>;
 
/**
 * Definition of a scoped object holding a CGDataProviderRef object.
 * The wrapped CGDataProviderRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCGDataProviderRef = ScopedObjectCompileTimeVoidT<CGDataProviderRef, CGDataProviderRelease>;
 
/**
 * Definition of a scoped object holding a CGColorRef object.
 * The wrapped CGColorRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCGColorRef = ScopedObjectCompileTimeVoidT<CGColorRef, CGColorRelease>;
 
/**
 * Definition of a scoped object holding a CGColorSpaceRef object.
 * The wrapped CGColorSpaceRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCGColorSpaceRef = ScopedObjectCompileTimeVoidT<CGColorSpaceRef, CGColorSpaceRelease>;
 
/**
 * Definition of a scoped object holding a CFNumberRef object.
 * The wrapped CFNumberRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFNumberRef = ScopedObjectCompileTimeT<CFNumberRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CFDictionaryRef object.
 * The wrapped CFDictionaryRef object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFDictionaryRef = ScopedObjectCompileTimeT<CFDictionaryRef, CFTypeRef, void, CFRelease>;
 
/**
 * Definition of a scoped object holding a CFType object.
 * The wrapped CFType object will be released automatically once the scoped object does not exist anymore.
 * @ingroup platformapple
 */
using ScopedCFTypeRef = ScopedObjectCompileTimeVoidT<CFTypeRef, CFRelease>;
 
}
 
}
 
}
 
#endif // META_OCEAN_PLATFORM_APPLE_APPLE_H