objc2-game-controller 0.3.2

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// A GCMicroGamepadSnapshot snapshot is a concrete GCMicroGamepad implementation. It can be used directly in an
    /// application to implement controller input replays. It is also returned as the result of polling
    /// a controller.
    ///
    /// The current snapshotData is readily available to access as NSData. A developer can serialize this to any
    /// destination necessary using the NSData API.
    ///
    /// The data contains some version of a GCMicroGamepadSnapShotData structure.
    ///
    ///
    /// See: -[GCMicroGamepad saveSnapshot]
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/gamecontroller/gcmicrogamepadsnapshot?language=objc)
    #[unsafe(super(GCMicroGamepad, GCPhysicalInputProfile, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "GCMicroGamepad", feature = "GCPhysicalInputProfile"))]
    #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
    pub struct GCMicroGamepadSnapshot;
);

#[cfg(all(feature = "GCMicroGamepad", feature = "GCPhysicalInputProfile"))]
extern_conformance!(
    unsafe impl NSObjectProtocol for GCMicroGamepadSnapshot {}
);

#[cfg(all(feature = "GCMicroGamepad", feature = "GCPhysicalInputProfile"))]
impl GCMicroGamepadSnapshot {
    extern_methods!(
        #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
        #[unsafe(method(snapshotData))]
        #[unsafe(method_family = none)]
        pub unsafe fn snapshotData(&self) -> Retained<NSData>;

        /// Setter for [`snapshotData`][Self::snapshotData].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
        #[unsafe(method(setSnapshotData:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setSnapshotData(&self, snapshot_data: &NSData);

        #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
        #[unsafe(method(initWithSnapshotData:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithSnapshotData(this: Allocated<Self>, data: &NSData) -> Retained<Self>;

        #[cfg(feature = "GCController")]
        #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
        #[unsafe(method(initWithController:snapshotData:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithController_snapshotData(
            this: Allocated<Self>,
            controller: &GCController,
            data: &NSData,
        ) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "GCMicroGamepad", feature = "GCPhysicalInputProfile"))]
impl GCMicroGamepadSnapshot {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

/// [Apple's documentation](https://developer.apple.com/documentation/gamecontroller/gcmicrogamepadsnapshotdataversion?language=objc)
// NS_ENUM
#[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct GCMicroGamepadSnapshotDataVersion(pub NSInteger);
impl GCMicroGamepadSnapshotDataVersion {
    #[doc(alias = "GCMicroGamepadSnapshotDataVersion1")]
    #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
    pub const Version1: Self = Self(0x0100);
}

unsafe impl Encode for GCMicroGamepadSnapshotDataVersion {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for GCMicroGamepadSnapshotDataVersion {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/gamecontroller/gccurrentmicrogamepadsnapshotdataversion?language=objc)
    #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
    pub static GCCurrentMicroGamepadSnapshotDataVersion: GCMicroGamepadSnapshotDataVersion;
}

/// [Apple's documentation](https://developer.apple.com/documentation/gamecontroller/gcmicrogamepadsnapshotdata?language=objc)
#[repr(C, packed)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct GCMicroGamepadSnapshotData {
    pub version: u16,
    pub size: u16,
    pub dpadX: c_float,
    pub dpadY: c_float,
    pub buttonA: c_float,
    pub buttonX: c_float,
}

unsafe impl Encode for GCMicroGamepadSnapshotData {
    const ENCODING: Encoding = Encoding::Struct(
        "?",
        &[
            <u16>::ENCODING,
            <u16>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
        ],
    );
}

unsafe impl RefEncode for GCMicroGamepadSnapshotData {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

impl GCMicroGamepadSnapshotData {
    /// Fills out a snapshot from any compatible NSData source
    ///
    ///
    /// Returns: NO if data is nil, snapshotData is nil or the contents of data does not contain a compatible snapshot. YES for all other cases.
    ///
    /// # Safety
    ///
    /// `snapshot_data` must be a valid pointer or null.
    #[doc(alias = "GCMicroGamepadSnapshotDataFromNSData")]
    #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
    #[inline]
    pub unsafe fn from_ns_data(
        snapshot_data: *mut GCMicroGamepadSnapshotData,
        data: Option<&NSData>,
    ) -> bool {
        extern "C-unwind" {
            fn GCMicroGamepadSnapshotDataFromNSData(
                snapshot_data: *mut GCMicroGamepadSnapshotData,
                data: Option<&NSData>,
            ) -> Bool;
        }
        unsafe { GCMicroGamepadSnapshotDataFromNSData(snapshot_data, data) }.as_bool()
    }
}

/// Creates an NSData object from a snapshot.
/// If the version and size is not set in the snapshot the data will automatically have version GCCurrentMicroGamepadSnapshotDataVersion and sizeof(GCMicroGamepadSnapshotData) set as the values implicitly.
///
///
/// Returns: nil if the snapshot is NULL, otherwise an NSData instance compatible with GCGamepadSnapshot.snapshotData
///
/// # Safety
///
/// `snapshot_data` must be a valid pointer or null.
#[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
#[inline]
pub unsafe extern "C-unwind" fn NSDataFromGCMicroGamepadSnapshotData(
    snapshot_data: *mut GCMicroGamepadSnapshotData,
) -> Option<Retained<NSData>> {
    extern "C-unwind" {
        fn NSDataFromGCMicroGamepadSnapshotData(
            snapshot_data: *mut GCMicroGamepadSnapshotData,
        ) -> *mut NSData;
    }
    let ret = unsafe { NSDataFromGCMicroGamepadSnapshotData(snapshot_data) };
    unsafe { Retained::retain_autoreleased(ret) }
}

/// [Apple's documentation](https://developer.apple.com/documentation/gamecontroller/gcmicrogamepadsnapshotdatav100?language=objc)
#[repr(C, packed)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct GCMicroGamepadSnapShotDataV100 {
    pub version: u16,
    pub size: u16,
    pub dpadX: c_float,
    pub dpadY: c_float,
    pub buttonA: c_float,
    pub buttonX: c_float,
}

unsafe impl Encode for GCMicroGamepadSnapShotDataV100 {
    const ENCODING: Encoding = Encoding::Struct(
        "?",
        &[
            <u16>::ENCODING,
            <u16>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
            <c_float>::ENCODING,
        ],
    );
}

unsafe impl RefEncode for GCMicroGamepadSnapShotDataV100 {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

impl GCMicroGamepadSnapShotDataV100 {
    /// Fills out a v100 snapshot from any compatible NSData source
    ///
    ///
    /// Returns: NO if data is nil, snapshotData is nil or the contents of data does not contain a compatible snapshot. YES for all other cases.
    ///
    /// # Safety
    ///
    /// `snapshot_data` must be a valid pointer or null.
    #[doc(alias = "GCMicroGamepadSnapShotDataV100FromNSData")]
    #[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
    #[inline]
    pub unsafe fn from_ns_data(
        snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
        data: Option<&NSData>,
    ) -> bool {
        extern "C-unwind" {
            fn GCMicroGamepadSnapShotDataV100FromNSData(
                snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
                data: Option<&NSData>,
            ) -> Bool;
        }
        unsafe { GCMicroGamepadSnapShotDataV100FromNSData(snapshot_data, data) }.as_bool()
    }
}

/// Creates an NSData object from a v100 snapshot.
/// If the version and size is not set in the snapshot the data will automatically have version 0x100 and sizeof(GCMicroGamepadSnapShotDataV100) set as the values implicitly.
///
///
/// Returns: nil if the snapshot is NULL, otherwise an NSData instance compatible with GCGamepadSnapshot.snapshotData
///
/// # Safety
///
/// `snapshot_data` must be a valid pointer or null.
#[deprecated = "Use the -[GCController controllerWithMicroGamepad] method instead"]
#[inline]
pub unsafe extern "C-unwind" fn NSDataFromGCMicroGamepadSnapShotDataV100(
    snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
) -> Option<Retained<NSData>> {
    extern "C-unwind" {
        fn NSDataFromGCMicroGamepadSnapShotDataV100(
            snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
        ) -> *mut NSData;
    }
    let ret = unsafe { NSDataFromGCMicroGamepadSnapShotDataV100(snapshot_data) };
    unsafe { Retained::retain_autoreleased(ret) }
}

#[deprecated = "renamed to `GCMicroGamepadSnapshotData::from_ns_data`"]
#[inline]
pub unsafe extern "C-unwind" fn GCMicroGamepadSnapshotDataFromNSData(
    snapshot_data: *mut GCMicroGamepadSnapshotData,
    data: Option<&NSData>,
) -> bool {
    extern "C-unwind" {
        fn GCMicroGamepadSnapshotDataFromNSData(
            snapshot_data: *mut GCMicroGamepadSnapshotData,
            data: Option<&NSData>,
        ) -> Bool;
    }
    unsafe { GCMicroGamepadSnapshotDataFromNSData(snapshot_data, data) }.as_bool()
}

#[deprecated = "renamed to `GCMicroGamepadSnapShotDataV100::from_ns_data`"]
#[inline]
pub unsafe extern "C-unwind" fn GCMicroGamepadSnapShotDataV100FromNSData(
    snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
    data: Option<&NSData>,
) -> bool {
    extern "C-unwind" {
        fn GCMicroGamepadSnapShotDataV100FromNSData(
            snapshot_data: *mut GCMicroGamepadSnapShotDataV100,
            data: Option<&NSData>,
        ) -> Bool;
    }
    unsafe { GCMicroGamepadSnapShotDataV100FromNSData(snapshot_data, data) }.as_bool()
}