GLKTextureLoader Class

Reference

Definition

Namespace:: GLKit

Assembly:: Xamarin.iOS.dll

Assembly:: Xamarin.Mac.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Loads Image and cube maps into OpenGL textures.

[Foundation.Register("GLKTextureLoader", true)]
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 12, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'Metal' instead.")]
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.TvOS, 12, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'Metal' instead.")]
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.MacOSX, 10, 14, ObjCRuntime.PlatformArchitecture.None, "Use 'Metal' instead.")]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class GLKTextureLoader : Foundation.NSObject

type GLKTextureLoader = class
    inherit NSObject

Inheritance: Object

NSObject
GLKTextureLoader

Attributes: RegisterAttribute DeprecatedAttribute IntroducedAttribute

Remarks

GLTextureLoader simplifies the process of loading textures and cube maps by providing a high-level API that can load images on a variety of graphic file formats (PNG, JPEG, TIFF and other formats supported by ImageIO. The data can be loaded both synchronously and asynchrously from T:MonoTOuch.CoreGraphics.CGImage objects, in-memory binary data, files and arbitrary NSUrl locations.

You can control how textures are loaded by configuring the GLKTextureOperations object. You can configure whether the texture will be premultiplied by their alpha channel or not, whether mipmaps should be created from the source image when the texture is loaded and whether the image should be flipped when it is loaded.

To use the texture loader, make an EAGLContext current, use one of the loading methods in this class and use the values in the returned GLKTextureInfo which contains the OpenGL object name (an uint), properties such as width, heigh, alpha, origin and mipmapping.

To use the texture loaded asynchrously, create the context using the EAGLContext's sharegroup. Then you call one of the

//
// if myQueue is null, it dispatches into the main queue.
void AsyncLoad (EAGLContext context, DispatchQueue myQueue)
{
    var shareGroup = context.ShareGroup;
    var loader = new GLTextureLoader (shareGroup);
    var textureOperations = new GLKTextureOperations () {
        ApplyPremultiplication = true,
        GenerateMipmaps = true
    }

    loader.BeginTextureLoad ("file.png", textureOperations, myQueue, TextureLoadedCallback);
}

// 
// Called on the specified queue.
//
void TextureLoadedCallback (GLKTextureInfo textureInfo, NSError error)
{
    // Use texture info here.
}

Constructors

GLKTextureLoader()	Default constructor that initializes a new instance of this class with no parameters.
GLKTextureLoader(EAGLSharegroup)	Creates a GLKTextureLoader for an EAGLSharegroup, used for asynchronous texture loading.
GLKTextureLoader(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
GLKTextureLoader(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
GLKTextureLoader(NSOpenGLContext)

Properties

ApplyPremultiplication	Represents the value associated with the constant GLKTextureLoaderApplyPremultiplication
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
ErrorDomain	Represents the value associated with the constant GLKTextureLoaderErrorDomain
ErrorKey	Represents the value associated with the constant GLKTextureLoaderErrorKey
GenerateMipmaps	Represents the value associated with the constant GLKTextureLoaderGenerateMipmaps
GLErrorKey	Represents the value associated with the constant GLKTextureLoaderGLErrorKey
GrayscaleAsAlpha	Represents the value associated with the constant GLKTextureLoaderGrayscaleAsAlpha
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
OriginBottomLeft	Represents the value associated with the constant GLKTextureLoaderOriginBottomLeft
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
SRGB	Represents the value associated with the constant GLKTextureLoaderSRGB
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
BeginLoadCubeMap(NSUrl, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(NSUrl, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(NSUrl[], GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(NSUrl[], NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(String, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(String, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(String[], GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMap(String[], NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a cube map.
BeginLoadCubeMapAsync(NSUrl, NSDictionary, DispatchQueue)	Asynchronously loads a cube map.
BeginLoadCubeMapAsync(String, NSDictionary, DispatchQueue)	Asynchronously loads a cube map.
BeginTextureLoad(CGImage, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(CGImage, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(NSData, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(NSData, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(NSUrl, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(NSUrl, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(String, GLKTextureOperations, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoad(String, nfloat, NSBundle, NSDictionary<NSString,NSNumber>, DispatchQueue, GLKTextureLoaderCallback)
BeginTextureLoad(String, NSDictionary, DispatchQueue, GLKTextureLoaderCallback)	Asynchronously loads a texture.
BeginTextureLoadAsync(CGImage, NSDictionary, DispatchQueue)	Asynchronously loads a texture.
BeginTextureLoadAsync(NSData, NSDictionary, DispatchQueue)	Asynchronously loads a texture.
BeginTextureLoadAsync(NSUrl, NSDictionary, DispatchQueue)	Asynchronously loads a texture.
BeginTextureLoadAsync(String, nfloat, NSBundle, NSDictionary<NSString,NSNumber>, DispatchQueue)
BeginTextureLoadAsync(String, NSDictionary, DispatchQueue)	Asynchronously loads a texture.
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
CubeMapFromFile(String, GLKTextureOperations, NSError)	Loads a cube map synchronously.
CubeMapFromFile(String, NSDictionary, NSError)	Loads a cube map synchronously.
CubeMapFromFiles(String[], GLKTextureOperations, NSError)	Loads a cube map synchronously.
CubeMapFromFiles(String[], NSDictionary, NSError)	Loads a cube map synchronously.
CubeMapFromUrl(NSUrl, GLKTextureOperations, NSError)	Loads a cube map synchronously.
CubeMapFromUrl(NSUrl, NSDictionary, NSError)	Loads a cube map synchronously.
CubeMapFromUrls(NSUrl[], GLKTextureOperations, NSError)	Loads a cube map synchronously.
CubeMapFromUrls(NSUrl[], NSDictionary, NSError)	Loads a cube map synchronously.
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
FromData(NSData, GLKTextureOperations, NSError)	Loads a texture from an NSData source.
FromData(NSData, NSDictionary, NSError)	Loads a texture from an NSData source.
FromFile(String, GLKTextureOperations, NSError)	Loads a texture from a file synchronously.
FromFile(String, NSDictionary, NSError)	Loads a texture from a file synchronously.
FromImage(CGImage, GLKTextureOperations, NSError)	Loads a texture from a CGImage.
FromImage(CGImage, NSDictionary, NSError)	Loads a texture from a CGImage.
FromName(String, nfloat, NSBundle, NSDictionary<NSString,NSNumber>, NSError)
FromUrl(NSUrl, GLKTextureOperations, NSError)	Loads a texture from a file pointed to by the url.
FromUrl(NSUrl, NSDictionary, NSError)	Loads a texture from a file pointed to by the url.
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via