Bitmap

open class Bitmap : BitmapProtocol

The Bitmap type acts as an owner of an underlying CoglBitmap instance. It provides the methods that can operate on this data type through BitmapProtocol conformance. Use Bitmap as a strong reference or owner of a CoglBitmap instance.

Show on GitHub
  • ptr 
    Untyped pointer to the underlying `CoglBitmap` instance.

    For type-safe access, use the generated, typed pointer bitmap_ptr property instead.

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!
    Show on GitHub

  • Designated initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<CoglBitmap>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<CoglBitmap>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<CoglBitmap>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<CoglBitmap>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. CoglBitmap does not allow reference counting, so despite the name no actual retaining will occur. i.e., ownership is transferred to the Bitmap instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<CoglBitmap>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements BitmapProtocol CoglBitmap does not allow reference counting.

    Declaration

    Swift

    @inlinable
public init<T>(_ other: T) where T : BitmapProtocol

    Parameters

    other

    an instance of a related type that implements BitmapProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to BitmapProtocol.

    Declaration

    Swift

    @inlinable
public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Loads an image file from disk. This function can be safely called from within a thread.

    Declaration

    Swift

    @inlinable
public init(file filename: UnsafePointer<CChar>!) throws
    Show on GitHub

  • Loads an image file from disk. This function can be safely called from within a thread.

    Declaration

    Swift

    @inlinable
public static func newFrom(file filename: UnsafePointer<CChar>!) throws -> Bitmap!
    Show on GitHub