CLImageDesc

java.lang.Object

au.notzed.zcl.CLImageDesc

public class CLImageDesc
extends java.lang.Object

Holder for cl_image_desc equivalent.

panama notes

To maintain compatability with the previous api this remains as a simple pojo and marshalling is done as required.

This also means it doesn't have to deal with allocation and deallocation and so on.

Field Summary

Fields
Modifier and Type	Field	Description
`long`	`imageArraySize`
`long`	`imageDepth`
`long`	`imageHeight`
`long`	`imageRowPitch`
`long`	`imageSlicePitch`
`int`	`imageType`
`long`	`imageWidth`
`CLMemory`	`memObject`
`long`	`numMipLevels`
`long`	`numSamples`
`static long`	`sizeof`

Constructor Summary

Constructors
Constructor	Description
`CLImageDesc()`
`CLImageDesc(int imageType, long imageWidth, long imageHeight, long imageDepth, long imageArraySize, long imageRowPitch, long imageSlicePitch, long numMipLevels, long numSamples, CLMemory memObject)`

Method Summary

Modifier and Type	Method	Description
`static CLImageDesc`	`create2D(int w, int h)`	Create a 2d image descriptor.
`static CLImageDesc`	`create2D(int w, int h, int count)`	Create a 2d image array descriptor.
`static CLImageFormat`	`fromNative(jdk.incubator.foreign.MemoryAddress addr)`
`static jdk.incubator.foreign.MemoryLayout`	`layout()`
`static <T extends CLProperty> jdk.incubator.foreign.MemoryAddress`	`toNative(Allocator frame, CLImageDesc d)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- imageType
  
  public int imageType
- imageWidth
  
  public long imageWidth
- imageHeight
  
  public long imageHeight
- imageDepth
  
  public long imageDepth
- imageArraySize
  
  public long imageArraySize
- imageRowPitch
  
  public long imageRowPitch
- imageSlicePitch
  
  public long imageSlicePitch
- numMipLevels
  
  public long numMipLevels
- numSamples
  
  public long numSamples
- memObject
  
  public CLMemory memObject
- sizeof
  
  public static final long sizeof
  
  See Also:
  
  Constant Field Values
Constructor Details
- CLImageDesc
  
  public CLImageDesc()
- CLImageDesc
  
  public CLImageDesc(int imageType, long imageWidth, long imageHeight, long imageDepth, long imageArraySize, long imageRowPitch, long imageSlicePitch, long numMipLevels, long numSamples, CLMemory memObject)
Method Details
- create2D
  
  public static CLImageDesc create2D(int w, int h)
  
  Create a 2d image descriptor.
  
  Parameters:
  
  w -
  
  h -
  
  Returns:
- create2D
  
  public static CLImageDesc create2D(int w, int h, int count)
  
  Create a 2d image array descriptor.
  
  Parameters:
  
  w -
  
  h -
  
  count -
  
  Returns:
- toNative
  
  public static <T extends CLProperty> jdk.incubator.foreign.MemoryAddress toNative(Allocator frame, CLImageDesc d)
- fromNative
  
  public static CLImageFormat fromNative(jdk.incubator.foreign.MemoryAddress addr)
- layout
  
  public static jdk.incubator.foreign.MemoryLayout layout()