Objc2 Core Graphics

https://docs.rs/objc2-core-graphics/latest/
Admin
Objc2 Core Graphics provides Rust bindings to Apple's CoreGraphics framework for graphics, display,...
Tokens:548,723
Snippets:3,914
Trust Score:9.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example for as_ref

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::as_ref.

```rust
let text: Option<String> = Some("Hello, world!".to_string());
// First, cast `Option<String>` to `Option<&String>` with `as_ref`,
// then consume *that* with `map`, leaving `text` on the stack.
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");
```

--------------------------------

### Example for as_mut

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::as_mut.

```rust
let mut x = Some(2);
match x.as_mut() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));
```

--------------------------------

### Example for into_flat_iter

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::into_flat_iter, a nightly-only API.

```rust
#![feature(option_into_flat_iter)]

let o1 = Some([1, 2]);
let o2 = None::<&[usize]>;

assert_eq!(o1.into_flat_iter().collect::<Vec<_>>(), [1, 2]);
assert_eq!(o2.into_flat_iter().collect::<Vec<_>>(), Vec::<&usize>::new());
```

--------------------------------

### Example for is_none

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::is_none.

```rust
let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);
```

--------------------------------

### Example for is_none_or

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::is_none_or.

```rust
let x: Option<u32> = Some(2);
assert_eq!(x.is_none_or(|x| x > 1), true);

let x: Option<u32> = Some(0);
assert_eq!(x.is_none_or(|x| x > 1), false);

let x: Option<u32> = None;
assert_eq!(x.is_none_or(|x| x > 1), true);

let x: Option<String> = Some("ownership".to_string());
assert_eq!(x.as_ref().is_none_or(|x| x.len() > 1), true);
println!("still alive {:?}", x);
```

--------------------------------

### Option::expect usage and recommended message

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataProviderGetBytesCallback.html

Shows usage of Option::expect. First example returns value for Some. Second example (marked ⓘ) demonstrates panic on None with custom message. Third example (marked ⓘ) shows recommended message style describing why Some is expected.

```rust
let x = Some("value");
assert_eq!(x.expect("fruits are healthy"), "value");
```

```rust
let x: Option<&str> = None;
x.expect("fruits are healthy"); // panics with `fruits are healthy`
```

```rust
let item = slice.get(0)
    .expect("slice should not be empty");
```

--------------------------------

### map_or_else examples

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGPSConverterProgressCallback.html

Demonstrates map_or_else with a default function and a mapping function. Includes a fallback example using Result.

```rust
let k = 21;

let x = Some("foo");
assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 3);

let x: Option<&str> = None;
assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 42);
```

```rust
let v: u64 = std::env::args()
   .nth(1)
   .map_or_else(|| std::fs::read_to_string("/etc/someconfig.conf"), Ok)?
   .parse()?;
```

--------------------------------

### Example for is_some_and

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::is_some_and.

```rust
let x: Option<u32> = Some(2);
assert_eq!(x.is_some_and(|x| x > 1), true);

let x: Option<u32> = Some(0);
assert_eq!(x.is_some_and(|x| x > 1), false);

let x: Option<u32> = None;
assert_eq!(x.is_some_and(|x| x > 1), false);

let x: Option<String> = Some("ownership".to_string());
assert_eq!(x.as_ref().is_some_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
```

--------------------------------

### take example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how Option::take removes the value and leaves None.

```rust
let mut x = Some(2);
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, Some(2));

let mut x: Option<u32> = None;
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, None);
```

--------------------------------

### Example for is_some

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Example usage of Option::is_some.

```rust
let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);
```

--------------------------------

### Option::from example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates Option::from, which moves a value into a new Some.

```rust
let o: Option<u8> = Option::from(67);

assert_eq!(Some(67), o);
```

--------------------------------

### xor example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how Option::xor returns Some only if exactly one of the options is Some.

```rust
let x = Some(2);
let y: Option<u32> = None;
assert_eq!(x.xor(y), Some(2));

let x: Option<u32> = None;
let y = Some(2);
assert_eq!(x.xor(y), Some(2));

let x = Some(2);
let y = Some(2);
assert_eq!(x.xor(y), None);

let x: Option<u32> = None;
let y: Option<u32> = None;
assert_eq!(x.xor(y), None);
```

--------------------------------

### CGDisplayStreamStart

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/fn.CGDisplayStreamStart.html

Starts a display stream. Deprecated: renamed to CGDisplayStream::start.

```APIDOC
## CGDisplayStreamStart

### Description
Starts a display stream. Deprecated: renamed to `CGDisplayStream::start`.

### Function Signature
```rust
pub extern "C-unwind" fn CGDisplayStreamStart(
    display_stream: Option<&CGDisplayStream>,
) -> CGError
```

### Parameters
- **display_stream** (Option<&CGDisplayStream>) - The display stream to start.

### Return Value
- **CGError** - The result of the operation.

### Availability
Available on **crate features `CGDisplayStream` and `CGError`** only.

### Deprecation
Deprecated: renamed to `CGDisplayStream::start`.
```

--------------------------------

### Option::default example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows that Option::default returns None.

```rust
let opt: Option<u32> = Option::default();
assert!(opt.is_none());
```

--------------------------------

### unwrap panic example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates that unwrap panics when the value is None.

```rust
let x: Option<&str> = None;
assert_eq!(x.unwrap(), "air"); // fails
```

--------------------------------

### expect panic example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates that expect panics with the provided message when the value is None.

```rust
let x: Option<&str> = None;
x.expect("fruits are healthy"); // panics with `fruits are healthy`
```

--------------------------------

### replace example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how Option::replace replaces the value and returns the old value.

```rust
let mut x = Some(2);
let old = x.replace(5);
assert_eq!(x, Some(5));
assert_eq!(old, Some(2));
```

--------------------------------

### unwrap_or_default example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to use unwrap_or_default to get the contained value or the default value for the type.

```rust
assert_eq!(x.unwrap_or_default(), 0);
assert_eq!(y.unwrap_or_default(), 12);
```

--------------------------------

### expect recommended message style example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows the recommended style for expect messages, describing why the Option should be Some.

```rust
let item = slice.get(0)
    .expect("slice should not be empty");
```

--------------------------------

### iter_mut example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows Option::iter_mut to get a mutable iterator over the possibly contained value, allowing mutation.

```rust
let mut x = Some(4);
match x.iter_mut().next() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

let mut x: Option<u32> = None;
assert_eq!(x.iter_mut().next(), None);
```

--------------------------------

### as_deref example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates Option::as_deref to get a reference to the dereferenced value, leaving the original Option in place.

```rust
let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);
```

--------------------------------

### begin_page

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGContext.html

Begins a new page in the context. Unsafe due to raw pointer.

```APIDOC
## begin_page

### Description
Begins a new page in the context. Unsafe due to raw pointer.

### Function Signature
```rust
pub unsafe fn begin_page(c: Option<&CGContext>, media_box: *const CGRect)
```

### Parameters
- `c` (Option<&CGContext>) - Optional context.
- `media_box` (*const CGRect) - Pointer to the media box.

### Safety
- `media_box` must be a valid pointer or null.
```

--------------------------------

### as_deref_mut example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows Option::as_deref_mut to get a mutable reference to the dereferenced value, allowing mutation of the inner value.

```rust
let mut x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref_mut().map(|x| {
    x.make_ascii_uppercase();
    x
}), Some("HEY".to_owned().as_mut_str()));
```

--------------------------------

### unwrap_unchecked example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to use unwrap_unchecked to get the contained value without checking for None. Calling on None is undefined behavior.

```rust
let x = Some("air");
assert_eq!(unsafe { x.unwrap_unchecked() }, "air");
```

```rust
let x: Option<&str> = None;
assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); // Undefined behavior!
```

--------------------------------

### CGEXRToneMappingGammaGetDefaultOptions()

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/fn.CGEXRToneMappingGammaGetDefaultOptions.html

Returns the default options dictionary for EXR tone mapping gamma.

```APIDOC
## Function CGEXRToneMappingGammaGetDefaultOptions

### Description
Returns the default options dictionary for EXR tone mapping gamma.

### Signature
```rust
pub extern "C-unwind" fn CGEXRToneMappingGammaGetDefaultOptions() -> CFRetained<CFDictionary>
```

### Availability
Available on **crate feature `CGEXRToneMappingGamma`** only.

### Return Value
- **CFRetained<CFDictionary>** - The default options dictionary.
```

--------------------------------

### ok_or_else example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to use ok_or_else to transform an Option into a Result, mapping Some to Ok and None to Err(err()).

```rust
let x = Some("foo");
assert_eq!(x.ok_or_else(|| 0), Ok("foo"));
```

--------------------------------

### and example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates Option::and which returns None if the option is None, otherwise returns the provided option. Note that arguments are eagerly evaluated.

```rust
let x = Some(2);
let y: Option<&str> = None;
assert_eq!(x.and(y), None);

let x: Option<u32> = None;
let y = Some("foo");
assert_eq!(x.and(y), None);

let x = Some(2);
let y = Some("foo");
assert_eq!(x.and(y), Some("foo"));

let x: Option<u32> = None;
let y: Option<&str> = None;
assert_eq!(x.and(y), None);
```

--------------------------------

### begin_transparency_layer

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGContext.html

Begins a transparency layer. Unsafe due to auxiliary info generics.

```APIDOC
## begin_transparency_layer

### Description
Begins a transparency layer. Unsafe due to auxiliary info generics.

### Function Signature
```rust
pub unsafe fn begin_transparency_layer(
    c: Option<&CGContext>,
    auxiliary_info: Option<&CFDictionary>,
)
```

### Parameters
- `c` (Option<&CGContext>) - Optional context.
- `auxiliary_info` (Option<&CFDictionary>) - Auxiliary information.

### Safety
- `auxiliary_info` generics must be of the correct type.
```

--------------------------------

### Option::from_iter example: checked_add

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how Option::from_iter collects an iterator of Options into an Option of a container, stopping at the first None. This example uses checked_add.

```rust
let items = vec![0_u16, 1, 2];

let res: Option<Vec<u16>> = items
    .iter()
    .map(|x| x.checked_add(1))
    .collect();

assert_eq!(res, Some(vec![1, 2, 3]));
```

--------------------------------

### ok_or example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to use ok_or to transform an Option into a Result, mapping Some to Ok and None to Err. Note that err is eagerly evaluated.

```rust
let x = Some("foo");
assert_eq!(x.ok_or(0), Ok("foo"));

let x: Option<&str> = None;
assert_eq!(x.ok_or(0), Err(0));
```

--------------------------------

### Option::unwrap

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataProviderGetBytesCallback.html

Shows usage of Option::unwrap. First example returns contained value for Some. Second example (marked ⓘ) demonstrates panic on None, with a comment indicating failure.

```rust
let x = Some("air");
assert_eq!(x.unwrap(), "air");
```

```rust
let x: Option<&str> = None;
assert_eq!(x.unwrap(), "air"); // fails
```

--------------------------------

### and_then example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows Option::and_then to chain fallible operations that may return None. The first example uses a helper function, the second shows chaining on a 2D array.

```rust
fn sq_then_to_string(x: u32) -> Option<String> {
    x.checked_mul(x).map(|sq| sq.to_string())
}

assert_eq!(Some(2).and_then(sq_then_to_string), Some(4.to_string()));
assert_eq!(Some(1_000_000).and_then(sq_then_to_string), None); // overflowed!
assert_eq!(None.and_then(sq_then_to_string), None);
```

```rust
let arr_2d = [["A0", "A1"], ["B0", "B1"]];

let item_0_1 = arr_2d.get(0).and_then(|row| row.get(1));
assert_eq!(item_0_1, Some(&"A1"));

let item_2_0 = arr_2d.get(2).and_then(|row| row.get(0));
assert_eq!(item_2_0, None);
```

--------------------------------

### flags

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGEvent.rs.html

Gets the flags of an event.

```APIDOC
## flags

### Description
Gets the flags of an event.

### Method
flags

### Parameters
- **event** (Option<&CGEvent>) - Optional - The event to query.

### Returns
- **CGEventFlags** - The flags of the event.

```

--------------------------------

### ok_or_else example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to use Option::ok_or_else to convert an Option into a Result, providing a default error value when the option is None.

```rust
let x: Option<&str> = None;
assert_eq!(x.ok_or_else(|| 0), Err(0));
```

--------------------------------

### location

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGEvent.rs.html

Gets the location of an event.

```APIDOC
## location

### Description
Gets the location of an event.

### Method
location

### Parameters
- **event** (Option<&CGEvent>) - Optional - The event to query.

### Returns
- **CGPoint** - The location of the event.

```

--------------------------------

### timestamp

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGEvent.rs.html

Gets the timestamp of an event.

```APIDOC
## timestamp

### Description
Gets the timestamp of an event.

### Method
timestamp

### Parameters
- **event** (Option<&CGEvent>) - Optional - The event to query.

### Returns
- **CGEventTimestamp** - The timestamp of the event.

```

--------------------------------

### CGColorConversionInfoCreateForToneMapping

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/fn.CGColorConversionInfoCreateForToneMapping.html

Creates a color conversion info for tone mapping between color spaces with specified headrooms.

```APIDOC
## Function CGColorConversionInfoCreateForToneMapping

### Description
Creates a color conversion info object for tone mapping between a source and target color space, given source and target headroom values and a tone mapping method.

### Signature
```rust
pub unsafe extern "C-unwind" fn CGColorConversionInfoCreateForToneMapping(
    from: &CGColorSpace,
    source_headroom: c_float,
    to: &CGColorSpace,
    target_headroom: c_float,
    method: CGToneMapping,
    options: Option<&CFDictionary>,
    error: *mut *mut CFError,
) -> Option<CFRetained<CGColorConversionInfo>>
```

### Parameters
- **from** (`&CGColorSpace`) - The source color space.
- **source_headroom** (`c_float`) - The source headroom value.
- **to** (`&CGColorSpace`) - The target color space.
- **target_headroom** (`c_float`) - The target headroom value.
- **method** (`CGToneMapping`) - The tone mapping method.
- **options** (`Option<&CFDictionary>`) - Optional options dictionary.
- **error** (`*mut *mut CFError`) - Pointer to receive an error if creation fails.

### Return Value
Returns an optional `CFRetained<CGColorConversionInfo>` object, or `None` on failure.

### Availability
Available on crate features `CGColorConversionInfo`, `CGColorSpace`, and `CGToneMapping` only.

### Deprecation
Deprecated: renamed to `CGColorConversionInfo::new_for_tone_mapping`.
```

--------------------------------

### CGEventGetType

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the type of an event.

```APIDOC
## CGEventGetType

### Description
Gets the type of an event.

### Function
CGEventGetType

### Parameters
None

### Return Value
Event type.
```

--------------------------------

### begin_path

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGContext.html

Begins a new path. This is part of the path construction functions.

```APIDOC
## begin_path

### Description
Begins a new path.

### Method
`pub fn begin_path(c: Option<&CGContext>)`

### Parameters
- `c` (Option<&CGContext>) - Optional reference to the graphics context.

### Returns
None

```

--------------------------------

### CGRectGetMidY

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics

Gets the mid Y coordinate of a rectangle.

```APIDOC
## CGRectGetMidY

### Description
Returns the mid Y coordinate of the given rectangle.

### Function
CGRectGetMidY

### Parameters
- **rect** (CGRect) - The rectangle to query.

### Return Value
The mid Y coordinate.
```

--------------------------------

### CGBeginDisplayConfiguration

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGDisplayConfiguration.rs.html

Begins a display configuration session. The config parameter is an output pointer that receives a configuration token, which must be a valid pointer or null.

```APIDOC
## CGBeginDisplayConfiguration

### Description
Begins a display configuration session. The `config` parameter is an output pointer that receives a configuration token, which must be a valid pointer or null.

### Function Signature
```rust
pub fn CGBeginDisplayConfiguration(config: *mut CGDisplayConfigRef) -> CGError;
```

### Parameters
- **config** (*mut CGDisplayConfigRef) - Required - A pointer to a `CGDisplayConfigRef` variable that will receive the configuration token. Must be a valid pointer or null.

### Return Value
- **CGError** - The result of the operation. A value of `kCGErrorSuccess` (0) indicates success.

### Safety
`config` must be a valid pointer or null.

### Availability
Requires the `CGError` feature flag.
```

--------------------------------

### r#type

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGEvent.rs.html

Gets the type of an event.

```APIDOC
## r#type

### Description
Gets the type of an event.

### Method
r#type

### Parameters
- **event** (Option<&CGEvent>) - Optional - The event to query.

### Returns
- **CGEventType** - The type of the event.

```

--------------------------------

### Option::zip_with example (nightly)

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows Option::zip_with, a nightly-only API, which combines two Options using a function if both are Some.

```rust
#![feature(option_zip)]

#[derive(Debug, PartialEq)]
struct Point {
    x: f64,
    y: f64,
}

impl Point {
    fn new(x: f64, y: f64) -> Self {
        Self { x, y }
    }
}

let x = Some(17.5);
let y = Some(42.7);

assert_eq!(x.zip_with(y, Point::new), Some(Point { x: 17.5, y: 42.7 }));
assert_eq!(x.zip_with(None, Point::new), None);
```

--------------------------------

### Option::zip example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Demonstrates Option::zip, which combines two Options into a tuple if both are Some, otherwise returns None.

```rust
let x = Some(1);
let y = Some("hi");
let z = None::<u8>;

assert_eq!(x.zip(y), Some((1, "hi")));
assert_eq!(x.zip(z), None);
```

--------------------------------

### CGGetOnlineDisplayList

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the online display list.

```APIDOC
## CGGetOnlineDisplayList

### Description
Gets the online display list.

### Function
CGGetOnlineDisplayList

### Parameters
None

### Return Value
Array of online display IDs.
```

--------------------------------

### CGBeginDisplayConfiguration

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/fn.CGBeginDisplayConfiguration.html

Begins a display configuration session. The function is unsafe and requires a valid pointer or null for the config parameter.

```APIDOC
## CGBeginDisplayConfiguration

### Description
Begins a display configuration session. The function is unsafe and requires a valid pointer or null for the config parameter.

### Function Signature
```rust
pub unsafe extern "C-unwind" fn CGBeginDisplayConfiguration(
    config: *mut CGDisplayConfigRef,
) -> CGError
```

### Parameters
- **config** (`*mut CGDisplayConfigRef`) - Required - A mutable pointer to a display configuration object. Must be a valid pointer or null.

### Return Value
- **CGError** - The result of the operation.

### Safety
`config` must be a valid pointer or null.

### Availability
Available on **crate features `CGDisplayConfiguration` and `CGError`** only.
```

--------------------------------

### CGGetEventTapList

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the event tap list.

```APIDOC
## CGGetEventTapList

### Description
Gets the event tap list.

### Function
CGGetEventTapList

### Parameters
None

### Return Value
Array of event taps.
```

--------------------------------

### pub fn new( src: Option<&CGColorSpace>, dst: Option<&CGColorSpace>, ) -> Option<CFRetained<CGColorConversionInfo>>

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGColorConversionInfo.html

Creates a new color conversion info object with the given source and destination color spaces. Returns an optional retained reference.

```APIDOC
## [Rust] pub fn new( src: Option<&CGColorSpace>, dst: Option<&CGColorSpace>, ) -> Option<CFRetained<CGColorConversionInfo>>

### Description
Creates a new color conversion info object with the given source and destination color spaces.

### Method
Rust function

### Signature
pub fn new( src: Option<&CGColorSpace>, dst: Option<&CGColorSpace>, ) -> Option<CFRetained<CGColorConversionInfo>>

### Parameters
- **src** (Option<&CGColorSpace>) - Optional - Source color space.
- **dst** (Option<&CGColorSpace>) - Optional - Destination color space.

### Return Value
Option<CFRetained<CGColorConversionInfo>> - A retained reference to the new color conversion info, or None on failure.

### Availability
Available on crate feature `CGColorSpace` only.
```

--------------------------------

### CGGetDisplayTransferByTable

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the display transfer by table.

```APIDOC
## CGGetDisplayTransferByTable

### Description
Gets the display transfer by table.

### Function
CGGetDisplayTransferByTable

### Parameters
None

### Return Value
Transfer table data.
```

--------------------------------

### CGColorConversionInfoCreateWithOptions

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/fn.CGColorConversionInfoCreateWithOptions.html

Creates a color conversion info object with options. Deprecated in favor of CGColorConversionInfo::with_options.

```APIDOC
## CGColorConversionInfoCreateWithOptions

### Description
Creates a color conversion info object with options. Deprecated in favor of `CGColorConversionInfo::with_options`.

### Availability
Available on **crate features `CGColorConversionInfo` and `CGColorSpace`** only.

### Deprecation
Deprecated: renamed to `CGColorConversionInfo::with_options`.

### Signature
```rust
pub unsafe extern "C-unwind" fn CGColorConversionInfoCreateWithOptions(
    src: &CGColorSpace,
    dst: &CGColorSpace,
    options: Option<&CFDictionary>,
) -> Option<CFRetained<CGColorConversionInfo>>
```

### Parameters
- **src** (`&CGColorSpace`) - The source color space.
- **dst** (`&CGColorSpace`) - The destination color space.
- **options** (`Option<&CFDictionary>`) - Optional options dictionary.

### Return Value
Returns `Option<CFRetained<CGColorConversionInfo>>` - The created color conversion info object, or `None` on failure.
```

--------------------------------

### CGGetDisplayTransferByFormula

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the display transfer by formula.

```APIDOC
## CGGetDisplayTransferByFormula

### Description
Gets the display transfer by formula.

### Function
CGGetDisplayTransferByFormula

### Parameters
None

### Return Value
Transfer formula parameters.
```

--------------------------------

### CGGetActiveDisplayList

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets the active display list.

```APIDOC
## CGGetActiveDisplayList

### Description
Gets the active display list.

### Function
CGGetActiveDisplayList

### Parameters
None

### Return Value
Array of active display IDs.
```

--------------------------------

### CGPathGetBoundingBox

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics

Gets the bounding box of a path. Deprecated.

```APIDOC
## CGPathGetBoundingBox

### Description
Returns the bounding box of the given path.

### Function
CGPathGetBoundingBox

### Parameters
- **path** (CGPath) - The path to query.

### Return Value
A CGRect representing the bounding box.

### Deprecation
Deprecated.
```

--------------------------------

### new_device_gray

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGColorSpace.html

Creates a device gray color space.

```APIDOC
## new_device_gray

### Description
Creates a device gray color space.

### Signature
`pub fn new_device_gray() -> Option<CFRetained<CGColorSpace>>`

### Returns
- `Option<CFRetained<CGColorSpace>>` - The created color space, or `None` if creation fails.
```

--------------------------------

### Using product on Option<T>

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows how to multiply numbers parsed from strings using the product method. If any element fails to parse, the result is None.

```rust
let nums = vec!["5", "10", "1", "2"];
let total: Option<usize> = nums.iter().map(|w| w.parse::<usize>().ok()).product();
assert_eq!(total, Some(100));
let nums = vec!["5", "10", "one", "2"];
let total: Option<usize> = nums.iter().map(|w| w.parse::<usize>().ok()).product();
assert_eq!(total, None);
```

--------------------------------

### CGGetDisplaysWithOpenGLDisplayMask

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/all.html

Gets displays with an OpenGL display mask.

```APIDOC
## CGGetDisplaysWithOpenGLDisplayMask

### Description
Gets displays with an OpenGL display mask.

### Function
CGGetDisplaysWithOpenGLDisplayMask

### Parameters
None

### Return Value
Array of display IDs.
```

--------------------------------

### pub unsafe fn with_options( src: &CGColorSpace, dst: &CGColorSpace, options: Option<&CFDictionary>, ) -> Option<CFRetained<CGColorConversionInfo>>

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/struct.CGColorConversionInfo.html

Creates a new color conversion info object with the given source and destination color spaces and additional options. This function is unsafe because the options dictionary generics must be of the correct type.

```APIDOC
## [Rust] pub unsafe fn with_options( src: &CGColorSpace, dst: &CGColorSpace, options: Option<&CFDictionary>, ) -> Option<CFRetained<CGColorConversionInfo>>

### Description
Creates a new color conversion info object with the given source and destination color spaces and additional options.

### Method
Rust function (unsafe)

### Signature
pub unsafe fn with_options( src: &CGColorSpace, dst: &CGColorSpace, options: Option<&CFDictionary>, ) -> Option<CFRetained<CGColorConversionInfo>>

### Parameters
- **src** (&CGColorSpace) - Required - Source color space.
- **dst** (&CGColorSpace) - Required - Destination color space.
- **options** (Option<&CFDictionary>) - Optional - Additional options.

### Return Value
Option<CFRetained<CGColorConversionInfo>> - A retained reference to the new color conversion info, or None on failure.

### Safety
`options` generics must be of the correct type.

### Availability
Available on crate feature `CGColorSpace` only.
```

--------------------------------

### unwrap_or_else example

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics/type.CGDataConsumerPutBytesCallback.html

Shows that unwrap_or_else computes the default from a closure.

```rust
let k = 10;
assert_eq!(Some(4).unwrap_or_else(|| 2 * k), 4);
assert_eq!(None.unwrap_or_else(|| 2 * k), 20);
```

--------------------------------

### CGEventSourceButtonState

Source: https://docs.rs/objc2-core-graphics/latest/objc2_core_graphics

Gets the button state from an event source. Deprecated.

```APIDOC
## CGEventSourceButtonState

### Description
Gets the button state from an event source. Deprecated.

### Function
CGEventSourceButtonState

### Parameters
- **sourceID** (CGEventSourceStateID) - The source state ID.
- **button** (CGMouseButton) - The mouse button.

### Return Value
Whether the button is down.

### Deprecation
Deprecated.
```

--------------------------------

### CGColorConversionInfo::with_options

Source: https://docs.rs/objc2-core-graphics/latest/src/objc2_core_graphics/generated/CGColorConversionInfo.rs.html

Creates a new color conversion info object with options, using source and destination color spaces. This method is unsafe and requires that the options dictionary generics are of the correct type.

```APIDOC
## CGColorConversionInfo::with_options

### Description
Creates a new color conversion info object with options, using source and destination color spaces. This method is unsafe and requires that the options dictionary generics are of the correct type.

### Method
`pub unsafe fn with_options(src: &CGColorSpace, dst: &CGColorSpace, options: Option<&CFDictionary>) -> Option<CFRetained<CGColorConversionInfo>>`

### Parameters
- **src** (&CGColorSpace) - Source color space.
- **dst** (&CGColorSpace) - Destination color space.
- **options** (Option<&CFDictionary>) - Optional options dictionary.

### Return Value
- **Option<CFRetained<CGColorConversionInfo>>** - A retained reference to the new color conversion info, or `None` on failure.

### Safety
- `options` generics must be of the correct type.

### Availability
Requires the `CGColorSpace` feature.
```
Tokens:
Raw