CoreFoundation (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.macosx.CoreFoundation

public class CoreFoundation
extends java.lang.Object

Native bindings to <CoreFoundation.h>.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`FALSE` Boolean values.
`static long`	`kCFAllocatorDefault` This is a synonym for `NULL`, if you'd rather use a named constant.
`static long`	`kCFAllocatorMalloc` This allocator uses `malloc()`, `realloc()`, and `free()`.
`static long`	`kCFAllocatorMallocZone` This allocator explicitly uses the default malloc zone, returned by `malloc_default_zone()`.
`static long`	`kCFAllocatorNull` Null allocator which does nothing and allocates no memory.
`static long`	`kCFAllocatorSystemDefault` Default system allocator; you rarely need to use this.
`static long`	`kCFAllocatorUseContext` Special allocator argument to CFAllocatorCreate which means "use the functions given in the context to allocate the allocator itself as well".
`static int`	`kCFStringEncodingASCII` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingISOLatin1` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingMacRoman` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingNextStepLatin` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingNonLossyASCII` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUnicode` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF16` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF16BE` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF16LE` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF32` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF32BE` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF32LE` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingUTF8` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFStringEncodingWindowsLatin1` Platform-independent built-in encodings; always available on all platforms.
`static int`	`kCFURLHFSPathStyle` URL path styles.
`static int`	`kCFURLPOSIXPathStyle` URL path styles.
`static int`	`kCFURLWindowsPathStyle` URL path styles.
`static byte`	`TRUE` Boolean values.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`CFBundleCreate(long allocator, long bundleURL)` Creates a `CFBundle` object.
`static long`	`CFBundleGetBundleWithIdentifier(long bundleID)` Locates a bundle given its program-defined identifier.
`static long`	`CFBundleGetFunctionPointerForName(long bundle, long functionName)` Returns a pointer to a function in a bundle’s executable code using the function name as the search key.
`static void`	`CFRelease(long cf)` Releases a Core Foundation object.
`static long`	`CFRetain(long cf)` Retains a Core Foundation object.
`static long`	`CFStringCreateWithCString(long allocator, java.nio.ByteBuffer cStr, int encoding)` Creates an immutable string from a C string.
`static long`	`CFStringCreateWithCStringNoCopy(long allocator, java.nio.ByteBuffer cStr, int encoding, long contentsDeallocator)` Creates a CFString object from an external C string buffer that might serve as the backing store for the object.
`static long`	`CFURLCreateWithFileSystemPath(long allocator, long filePath, long pathStyle, boolean isDirectory)` Creates a `CFURL` object using a local file system path string.
`static long`	`nCFBundleCreate(long allocator, long bundleURL)` Unsafe version of: `CFBundleCreate(long, long)`
`static long`	`nCFBundleGetBundleWithIdentifier(long bundleID)` Unsafe version of: `CFBundleGetBundleWithIdentifier(long)`
`static long`	`nCFBundleGetFunctionPointerForName(long bundle, long functionName)` Unsafe version of: `CFBundleGetFunctionPointerForName(long, long)`
`static void`	`nCFRelease(long cf)` Unsafe version of: `CFRelease(long)`
`static long`	`nCFRetain(long cf)` Unsafe version of: `CFRetain(long)`
`static long`	`nCFStringCreateWithCString(long allocator, long cStr, int encoding)` Unsafe version of: `CFStringCreateWithCString(long, java.nio.ByteBuffer, int)`
`static long`	`nCFStringCreateWithCStringNoCopy(long allocator, long cStr, int encoding, long contentsDeallocator)` Unsafe version of: `CFStringCreateWithCStringNoCopy(long, java.nio.ByteBuffer, int, long)`
`static long`	`nCFURLCreateWithFileSystemPath(long allocator, long filePath, long pathStyle, boolean isDirectory)` Unsafe version of: `CFURLCreateWithFileSystemPath(long, long, long, boolean)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- TRUE
```
public static final byte TRUE
```
  Boolean values.
  
  See Also:
  
  Constant Field Values
- FALSE
```
public static final byte FALSE
```
  Boolean values.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingMacRoman
```
public static final int kCFStringEncodingMacRoman
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingWindowsLatin1
```
public static final int kCFStringEncodingWindowsLatin1
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingISOLatin1
```
public static final int kCFStringEncodingISOLatin1
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingNextStepLatin
```
public static final int kCFStringEncodingNextStepLatin
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingASCII
```
public static final int kCFStringEncodingASCII
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUnicode
```
public static final int kCFStringEncodingUnicode
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF8
```
public static final int kCFStringEncodingUTF8
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingNonLossyASCII
```
public static final int kCFStringEncodingNonLossyASCII
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF16
```
public static final int kCFStringEncodingUTF16
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF16BE
```
public static final int kCFStringEncodingUTF16BE
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF16LE
```
public static final int kCFStringEncodingUTF16LE
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF32
```
public static final int kCFStringEncodingUTF32
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF32BE
```
public static final int kCFStringEncodingUTF32BE
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFStringEncodingUTF32LE
```
public static final int kCFStringEncodingUTF32LE
```
  Platform-independent built-in encodings; always available on all platforms.
  
  See Also:
  
  Constant Field Values
- kCFURLPOSIXPathStyle
```
public static final int kCFURLPOSIXPathStyle
```
  URL path styles.
  
  See Also:
  
  Constant Field Values
- kCFURLHFSPathStyle
```
public static final int kCFURLHFSPathStyle
```
  URL path styles.
  
  See Also:
  
  Constant Field Values
- kCFURLWindowsPathStyle
```
public static final int kCFURLWindowsPathStyle
```
  URL path styles.
  
  See Also:
  
  Constant Field Values
- kCFAllocatorDefault
```
public static final long kCFAllocatorDefault
```
  This is a synonym for NULL, if you'd rather use a named constant.
- kCFAllocatorSystemDefault
```
public static final long kCFAllocatorSystemDefault
```
  Default system allocator; you rarely need to use this.
- kCFAllocatorMalloc
```
public static final long kCFAllocatorMalloc
```
  This allocator uses malloc(), realloc(), and free(). This should not be generally used; stick to kCFAllocatorDefault whenever possible. This allocator is useful as the "bytesDeallocator" in CFData or "contentsDeallocator" in CFString where the memory was obtained as a result of malloc() type functions.
- kCFAllocatorMallocZone
```
public static final long kCFAllocatorMallocZone
```
  This allocator explicitly uses the default malloc zone, returned by malloc_default_zone(). It should only be used when an object is safe to be allocated in non-scanned memory.
- kCFAllocatorNull
```
public static final long kCFAllocatorNull
```
  Null allocator which does nothing and allocates no memory. This allocator is useful as the "bytesDeallocator" in CFData or "contentsDeallocator" in CFString where the memory should not be freed.
- kCFAllocatorUseContext
```
public static final long kCFAllocatorUseContext
```
  Special allocator argument to CFAllocatorCreate which means "use the functions given in the context to allocate the allocator itself as well".

Method Detail

nCFRetain
```
public static long nCFRetain(long cf)
```
Unsafe version of: CFRetain(long)

CFRetain
```
public static long CFRetain(long cf)
```
Retains a Core Foundation object.
You should retain a Core Foundation object when you receive it from elsewhere (that is, you did not create or copy it) and you want it to persist. If you retain a Core Foundation object you are responsible for releasing it.

Parameters:

cf - the CFType object to retain

nCFRelease
```
public static void nCFRelease(long cf)
```
Unsafe version of: CFRelease(long)

CFRelease
```
public static void CFRelease(long cf)
```
Releases a Core Foundation object.
If the retain count of cf becomes zero the memory allocated to the object is deallocated and the object is destroyed. If you create, copy, or explicitly retain (see the CFRetain(long) function) a Core Foundation object, you are responsible for releasing it when you no longer need it.

Parameters:

cf - the CFType object to release

nCFBundleCreate

public static long nCFBundleCreate(long allocator,
                                   long bundleURL)

Unsafe version of: CFBundleCreate(long, long)

CFBundleCreate
```
public static long CFBundleCreate(long allocator,
                                  long bundleURL)
```
Creates a CFBundle object.

Parameters:

allocator - the allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

bundleURL - the location of the bundle for which to create a CFBundle object

nCFBundleGetBundleWithIdentifier
```
public static long nCFBundleGetBundleWithIdentifier(long bundleID)
```
Unsafe version of: CFBundleGetBundleWithIdentifier(long)

CFBundleGetBundleWithIdentifier
```
public static long CFBundleGetBundleWithIdentifier(long bundleID)
```
Locates a bundle given its program-defined identifier.

Parameters:

bundleID - the identifier of the bundle to locate. Note that identifier names are case-sensitive.

nCFBundleGetFunctionPointerForName

public static long nCFBundleGetFunctionPointerForName(long bundle,
                                                      long functionName)

Unsafe version of: CFBundleGetFunctionPointerForName(long, long)

CFBundleGetFunctionPointerForName
```
public static long CFBundleGetFunctionPointerForName(long bundle,
                                                     long functionName)
```
Returns a pointer to a function in a bundle’s executable code using the function name as the search key.

Parameters:

bundle - the bundle to examine

functionName - the name of the function to locate

nCFStringCreateWithCString

public static long nCFStringCreateWithCString(long allocator,
                                              long cStr,
                                              int encoding)

Unsafe version of: CFStringCreateWithCString(long, java.nio.ByteBuffer, int)

CFStringCreateWithCString

public static long CFStringCreateWithCString(long allocator,
                                             java.nio.ByteBuffer cStr,
                                             int encoding)

Creates an immutable string from a C string.

Parameters:

allocator - the allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

cStr - the NULL-terminated C string to be used to create the CFString object. The string must use an 8-bit encoding.

encoding - the encoding of the characters in the C string. The encoding must specify an 8-bit encoding. One of:

`kCFStringEncodingMacRoman`	`kCFStringEncodingWindowsLatin1`	`kCFStringEncodingISOLatin1`
`kCFStringEncodingNextStepLatin`	`kCFStringEncodingASCII`	`kCFStringEncodingUnicode`
`kCFStringEncodingUTF8`	`kCFStringEncodingNonLossyASCII`	`kCFStringEncodingUTF16`
`kCFStringEncodingUTF16BE`	`kCFStringEncodingUTF16LE`	`kCFStringEncodingUTF32`
`kCFStringEncodingUTF32BE`	`kCFStringEncodingUTF32LE`

nCFStringCreateWithCStringNoCopy

public static long nCFStringCreateWithCStringNoCopy(long allocator,
                                                    long cStr,
                                                    int encoding,
                                                    long contentsDeallocator)

Unsafe version of: CFStringCreateWithCStringNoCopy(long, java.nio.ByteBuffer, int, long)

CFStringCreateWithCStringNoCopy

public static long CFStringCreateWithCStringNoCopy(long allocator,
                                                   java.nio.ByteBuffer cStr,
                                                   int encoding,
                                                   long contentsDeallocator)

Creates a CFString object from an external C string buffer that might serve as the backing store for the object.

Parameters:

allocator - the allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

cStr - the NULL-terminated C string to be used to create the CFString object. The string must use an 8-bit encoding.

encoding - the encoding of the characters in the C string. The encoding must specify an 8-bit encoding. One of:

`kCFStringEncodingMacRoman`	`kCFStringEncodingWindowsLatin1`	`kCFStringEncodingISOLatin1`
`kCFStringEncodingNextStepLatin`	`kCFStringEncodingASCII`	`kCFStringEncodingUnicode`
`kCFStringEncodingUTF8`	`kCFStringEncodingNonLossyASCII`	`kCFStringEncodingUTF16`
`kCFStringEncodingUTF16BE`	`kCFStringEncodingUTF16LE`	`kCFStringEncodingUTF32`
`kCFStringEncodingUTF32BE`	`kCFStringEncodingUTF32LE`

contentsDeallocator - the CFAllocator object to use to deallocate the external string buffer when it is no longer needed. You can pass NULL or kCFAllocatorDefault to request the default allocator for this purpose. If the buffer does not need to be deallocated, or if you want to assume responsibility for deallocating the buffer (and not have the CFString object deallocate it), pass kCFAllocatorNull.

nCFURLCreateWithFileSystemPath

public static long nCFURLCreateWithFileSystemPath(long allocator,
                                                  long filePath,
                                                  long pathStyle,
                                                  boolean isDirectory)

Unsafe version of: CFURLCreateWithFileSystemPath(long, long, long, boolean)

CFURLCreateWithFileSystemPath
```
public static long CFURLCreateWithFileSystemPath(long allocator,
                                                 long filePath,
                                                 long pathStyle,
                                                 boolean isDirectory)
```
Creates a CFURL object using a local file system path string.

Parameters:

allocator - the allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

filePath - the path string to convert to a CFURL object. If filePath is not absolute, the resulting URL will be considered relative to the current working directory (evaluated when this function is being invoked).

pathStyle - the operating system path style used in filePath. One of:
kCFURLPOSIXPathStyle kCFURLHFSPathStyle kCFURLWindowsPathStyle

isDirectory - a Boolean value that specifies whether filePath is treated as a directory path when resolving against relative path components. Pass true if the pathname indicates a directory, false otherwise.

Class CoreFoundation

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRUE

FALSE

kCFStringEncodingMacRoman

kCFStringEncodingWindowsLatin1

kCFStringEncodingISOLatin1

kCFStringEncodingNextStepLatin

kCFStringEncodingASCII

kCFStringEncodingUnicode

kCFStringEncodingUTF8

kCFStringEncodingNonLossyASCII

kCFStringEncodingUTF16

kCFStringEncodingUTF16BE

kCFStringEncodingUTF16LE

kCFStringEncodingUTF32

kCFStringEncodingUTF32BE

kCFStringEncodingUTF32LE

kCFURLPOSIXPathStyle

kCFURLHFSPathStyle

kCFURLWindowsPathStyle

kCFAllocatorDefault

kCFAllocatorSystemDefault

kCFAllocatorMalloc

kCFAllocatorMallocZone

kCFAllocatorNull

kCFAllocatorUseContext

Method Detail

nCFRetain

CFRetain

nCFRelease

CFRelease

nCFBundleCreate

CFBundleCreate

nCFBundleGetBundleWithIdentifier

CFBundleGetBundleWithIdentifier