@NonNullByDefault

# Package com.io7m.jcanephora.core

Core types and interfaces.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  JCGLArrayBufferType | The type of array buffers.
  JCGLArrayBufferUsableType | The type of usable array buffers.
  JCGLArrayObjectBuilderType | A mutable builder for configuring array objects.
  JCGLArrayObjectType | An array object.
  JCGLArrayObjectUsableType | A usable array object.
  JCGLArrayVertexAttributeFloatingPointType | The type of array vertex attributes that will be converted to floating-point during shading.
  JCGLArrayVertexAttributeIntegralType | The type of array vertex attributes that are of an integer type and will not be converted during shading.
  JCGLArrayVertexAttributeMatcherType<A,E extends Exception> | The type of attribute matchers.
  JCGLArrayVertexAttributeType | The type of array vertex attributes.
  JCGLBufferUpdateType<T extends JCGLBufferWritableType> | An update that will replace data in a buffer.
  JCGLBufferUsableType | The type of usable buffers.
  JCGLBufferWritableType | The type of buffers allocated on the GPU that have mutable contents.
  JCGLClearSpecificationType | The type of buffer clearing specifications.
  JCGLDataUpdateType<T> | An update to data on the GPU (possibly a buffer or texture).
  JCGLFragmentShaderType | The type of fragment shaders.
  JCGLFragmentShaderUsableType | The type of usable fragment shaders.
  JCGLFramebufferBuilderType | A mutable builder for configuring framebuffer objects.
  JCGLFramebufferColorAttachmentMatcherType<A,E extends Throwable> | The type of color attachment matchers.
  JCGLFramebufferColorAttachmentPointType | A color attachment point on a framebuffer.
  JCGLFramebufferColorAttachmentType | The type of framebuffer color attachments.
  JCGLFramebufferDepthAttachmentMatcherType<A,E extends Throwable> | The type of depth attachment matchers.
  JCGLFramebufferDepthAttachmentType | The type of framebuffer depth attachments.
  JCGLFramebufferDepthStencilAttachmentMatcherType<A,E extends Throwable> | The type of depth+stencil attachment matchers.
  JCGLFramebufferDepthStencilAttachmentType | The type of framebuffer depth+stencil attachments.
  JCGLFramebufferDrawBufferType | An identifier for a draw buffer.
  JCGLFramebufferType | The type of framebuffers.
  JCGLFramebufferUsableType | A read-only interface to the `JCGLFramebufferType` type that allows use of the type but not mutation and/or deletion of the contents.
  JCGLGeometryShaderType | The type of geometry shaders.
  JCGLGeometryShaderUsableType | The type of usable geometry shaders.
  JCGLIndexBufferType | The type of index buffers.
  JCGLIndexBufferUsableType | The type of usable index buffers.
  JCGLNamedType | An object that has a name according to OpenGL.
  JCGLProgramAttributeType | The type of attributes in compiled programs.
  JCGLProgramShaderType | The type of program shaders.
  JCGLProgramShaderUsableType | The type of usable program shaders.
  JCGLProgramUniformType | The type of uniforms in compiled programs.
  JCGLProjectionMatricesType | Functions for creating projection matrices.
  JCGLQueryType | The type of queries.
  JCGLQueryUsableType | The type of usable queries.
  JCGLReferableType | The type of objects that can be referenced by a `JCGLReferenceContainerType`.
  JCGLReferenceContainerType | The type of resources that can contain other resources.
  JCGLResourceSizedType | The type of OpenGL resources that have a known size in bytes.
  JCGLResourceUsableType | The type of "usable" objects that can be deleted.
  JCGLTexture2DType | The type of 2D textures.
  JCGLTexture2DUpdateType | The type of updates for 2D textures.
  JCGLTexture2DUsableType | The type of usable 2D textures.
  JCGLTextureCubeType | The type of cube textures.
  JCGLTextureCubeUpdateType | The type of updates for cube textures.
  JCGLTextureCubeUsableType | The type of usable cube textures.
  JCGLTextureType | The type of textures.
  JCGLTextureUnitType | The type of texture units.
  JCGLTextureUsableType | The type of usable textures.
  JCGLTimerQueryType | The type of timer queries.
  JCGLTimerQueryUsableType | The type of usable timer queries.
  JCGLVertexShaderType | The type of vertex shaders.
  JCGLVertexShaderUsableType | The type of usable vertex shaders.
  JCGLViewMatricesType | Functions for producing view matrices.

- Class Summary
  Class | Description
  --- | ---
  JCGLBufferUpdates | Utility functions to allocate buffer updates.
  JCGLClearSpecification | The type of buffer clearing specifications.
  JCGLClearSpecification.Builder | Builds instances of type `JCGLClearSpecification`.
  JCGLClearSpecificationMutable | A modifiable implementation of the `JCGLClearSpecificationType` type.
  JCGLProjectionMatrices | Functions to produce projection matrices.
  JCGLResources | Resource checking.
  JCGLTextureFormats | Information about texture formats.
  JCGLTextureUpdates | Utility functions to allocate texture updates.
  JCGLVersion | A structure representing the version of the current OpenGL implementation.
  JCGLVersionNumber | A structure representing the version number of a given OpenGL implementation, broken into "major", "minor", and "micro" components.
  JCGLViewMatrices | Functions to produce view matrices.

- Enum Summary
  Enum | Description
  --- | ---
  JCGLBlendEquation | OpenGL blend equations.
  JCGLBlendFunction | Blend function specification.
  JCGLCubeMapFaceLH | The six faces of a cube map with a left-handed coordinate system (the default for OpenGL cube maps).
  JCGLCubeMapFaceRH | The six faces of a cube map with a right-handed coordinate system (see the documentation for details on how to use a right-handed coordinate system).
  JCGLDepthFunction | Depth function specification.
  JCGLFaceSelection | Specification for face selections.
  JCGLFaceWindingOrder | The order of vertices for front-facing faces.
  JCGLFramebufferBlitBuffer | The buffers that will be included in framebuffer blit operations.
  JCGLFramebufferBlitFilter | The filtering that will be used during framebuffer blit operations.
  JCGLFramebufferStatus | The result of validating a given framebuffer configuration.
  JCGLPixelFormat | The type of pixel data in client memory.
  JCGLPolygonMode | Polygon mode selection.
  JCGLPrimitives | Primitive type selection.
  JCGLQueryResultAvailability | The availability of a query result.
  JCGLScalarIntegralType | Type-safe interface to integral scalar types.
  JCGLScalarType | Type-safe interface to scalar types.
  JCGLStencilFunction | Stencil function specification.
  JCGLStencilOperation | Stencil operation specification.
  JCGLTextureFilterMagnification | OpenGL texture magnification filter specification.
  JCGLTextureFilterMinification | OpenGL texture minification filter specification.
  JCGLTextureFormat | Texture formats
  JCGLTextureWrapR | Texture wrapping mode on the R axis.
  JCGLTextureWrapS | Texture wrapping mode on the S axis.
  JCGLTextureWrapT | Texture wrapping mode on the T axis.
  JCGLType | Type-safe OpenGL shader types.
  JCGLUnsignedType | OpenGL unsigned types.
  JCGLUsageHint | Hints to the implementation about how array data will be used.

- Exception Summary
  Exception | Description
  --- | ---
  JCGLException | The type of exceptions raised by the API.
  JCGLExceptionAttributeAlreadyAssigned | Exception class representing an error caused by the programmer attempting to assign an array object vertex attribute that has already been assigned.
  JCGLExceptionBlendingMisconfigured | An exception indicating an attempt to combine an invalid set of blending equations.
  JCGLExceptionBufferNotBound | Exception class representing an error caused by the programmer failing to bind a buffer prior to attempting to perform an operation on it that requires binding.
  JCGLExceptionChecked | The type of checked exceptions raised by the API.
  JCGLExceptionConcurrency | An exception indicating an unspecified error relating to concurrency.
  JCGLExceptionContextIsCurrent | Exception class representing an error caused by the programmer attempting to make a context `c` current when any context (including `c`) is already current.
  JCGLExceptionContextNotCurrent | Exception class representing an error caused by the programmer attempting to use a context which is not current.
  JCGLExceptionDeleted | An exception indicating an attempt to delete a resource that has already been deleted.
  JCGLExceptionFeedback | Exception class representing an error caused by the programmer causing feedback.
  JCGLExceptionFormatError | An exception indicating that a texture is of an incorrect format.
  JCGLExceptionFramebufferInvalid | Exception class representing an error caused by an invalid framebuffer configuration.
  JCGLExceptionFramebufferNotBound | Exception class representing an error caused by a framebuffer not being bound where one is required.
  JCGLExceptionFramebufferReadDrawSame | Exception class representing an error caused by the user attempting to blit from a framebuffer to itself.
  JCGLExceptionFramebufferWrongBlitFilter | Exception class representing an error caused by an attempt to use a filter that cannot be used on the given framebuffer.
  JCGLExceptionNoDepthBuffer | An exception indicating an attempt to use a depth buffer on a framebuffer that does not have any kind of depth attachment.
  JCGLExceptionNonCompliant | An exception indicating that the package cannot execute on the current context because it does not comply to the OpenGL specification in some manner.
  JCGLExceptionNoStencilBuffer | An exception indicating an attempt to use a stencil buffer on a framebuffer that does not have any kind of stencil attachment.
  JCGLExceptionObjectNotDeletable | Exception class representing an error caused by the programmer attempting to delete an object that cannot be deleted.
  JCGLExceptionProgramCompileError | An exception indicating the failure to compile a given shading program.
  JCGLExceptionProgramNotActive | An exception indicating that an attempt was made to perform an operation on a program that required the program to be active, but the program turned out not to be active.
  JCGLExceptionProgramTypeError | An exception indicating that an attempt was made to set a program parameter using a value of the wrong type.
  JCGLExceptionQueryAlreadyRunning | Exception class representing an error caused by the programmer attempting to start a query running that is already running.
  JCGLExceptionQueryNotRunning | Exception class representing an error caused by the programmer attempting to stop a query that is not running.
  JCGLExceptionTextureNotBound | Exception class representing an error caused by the programmer attempting to perform an operation that requires that a texture be bound to a texture unit, but without one bound.
  JCGLExceptionUnsupported | An exception indicating that the package cannot execute on the current context version.
  JCGLExceptionWrongContext | Exception class representing an error caused by the programmer attempting to use an object on the wrong context.
  JCGLExceptionWrongImplementation | Exception class representing an error caused by the programmer attempting to use an object from the wrong JCGL implementation.

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  JCGLImmutableStyleType | Style settings for generated immutable types.

## Package com.io7m.jcanephora.core Description

Core types and interfaces.

Copyright © 2016 <code@io7m.com> http://io7m.com