IWICBitmapLock
COM公式ドキュメント
Lock メソッドをサポートするメソッドを公開します。
解説(Remarks)
ビットマップ ロックは、単にビットマップ内への矩形のメモリ ウィンドウを抽象化したものです。最も単純なケースであるシステム メモリ ビットマップの場合、これは矩形の左上隅を指すポインターと stride 値にすぎません。
Lock メソッドによって設定された排他ロックと、関連付けられた IWICBitmapLock オブジェクトを解放するには、IWICBitmapLock オブジェクトに対して IUnknown::Release を呼び出します。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
ロックされた矩形の幅と高さをピクセル単位で取得します。
| puiWidth | DWORD* | out | ロックされた矩形の幅を受け取るポインター。 |
| puiHeight | DWORD* | out | ロックされた矩形の高さを受け取るポインター。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
メモリの stride 値へのアクセスを提供します。
| pcbStride | DWORD* | out |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
解説(Remarks)
stride 値は、ビットマップではなく IWICBitmapLock に固有である点に注意してください。 たとえば、ビットマップの同じ矩形に対する 2 回連続したロックでは、内部実装によっては異なるポインターと stride 値が返される場合があります。
ロックされた矩形内の左上のピクセルへのポインターを取得します。
| pcbBufferSize | DWORD* | out | バッファーのサイズを受け取るポインター。 |
| ppbData | BYTE** | out | ロックされた矩形内の左上のピクセルへのポインターを受け取るポインター。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
解説(Remarks)
このメソッドで提供されるポインターは、ロック自体の有効期間を超えて使用しないでください。
GetDataPointer は、マルチスレッド アパートメント アプリケーションでは使用できません。
例
次の例では、IWICBitmapLock が指すデータをゼロで埋めています。
IWICImagingFactory *pFactory = NULL;
IWICBitmap *pBitmap = NULL;
UINT uiWidth = 640;
UINT uiHeight = 480;
WICPixelFormatGUID formatGUID = GUID_WICPixelFormat32bppARGB;
WICRect rcLock = { 0, 0, uiWidth, uiHeight };
IWICBitmapLock *pLock = NULL;
HRESULT hr = CoCreateInstance(
CLSID_WICImagingFactory,
NULL,
CLSCTX_INPROC_SERVER,
IID_IWICImagingFactory,
(LPVOID*)&pFactory
);
if (SUCCEEDED(hr))
{
hr = pFactory->CreateBitmap(uiWidth, uiHeight, formatGUID, WICBitmapCacheOnDemand, &pBitmap);
}
if (SUCCEEDED(hr))
{
hr = pBitmap->Lock(&rcLock, WICBitmapLockWrite, &pLock);
if (SUCCEEDED(hr))
{
UINT cbBufferSize = 0;
UINT cbStride = 0;
BYTE *pv = NULL;
// Retrieve the stride.
hr = pLock->GetStride(&cbStride);
if (SUCCEEDED(hr))
{
hr = pLock->GetDataPointer(&cbBufferSize, &pv);
}
if (SUCCEEDED(hr))
{
// Access the bitmap memory starting at pv, where
// each row begins cbStride bytes after the start
// of the preceding row.
}
// Release the bitmap lock.
pLock->Release();
}
}
if (pBitmap)
{
pBitmap->Release();
}
if (pFactory)
{
pFactory->Release();
}
return hr;
ロックされたピクセル領域のピクセル フォーマットを取得します。これは、ロックされた領域における 1 ピクセルあたりのバイト数を計算するために使用できます。
| pPixelFormat | GUID* | out | ロックされた領域のピクセル フォーマット GUID を受け取るポインター。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IWICBitmapLock "{00000123-A8F2-4877-BA0A-FD2B6645FB94}" #usecom global IWICBitmapLock IID_IWICBitmapLock "{}" #comfunc global IWICBitmapLock_GetSize 3 var,var #comfunc global IWICBitmapLock_GetStride 4 var #comfunc global IWICBitmapLock_GetDataPointer 5 var,var #comfunc global IWICBitmapLock_GetPixelFormat 6 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IWICBitmapLock "{00000123-A8F2-4877-BA0A-FD2B6645FB94}" #usecom global IWICBitmapLock IID_IWICBitmapLock "{}" #comfunc global IWICBitmapLock_GetSize 3 sptr,sptr #comfunc global IWICBitmapLock_GetStride 4 sptr #comfunc global IWICBitmapLock_GetDataPointer 5 sptr,sptr #comfunc global IWICBitmapLock_GetPixelFormat 6 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。